Order Equinix Internet Access with Dedicated Port
Equinix Internet Access (EIA) provides blended internet access using multiple tier-1 internet service providers (ISPs) and Equinix Internet Exchanges (IX) to deliver high availability, reliability, and speed.
Equinix Internet Access can be used for:
- Primary Internet Access – for customers that want to use Equinix Internet Access as their main internet connection.
- Backup Internet Access – for customers that use a different internet provider as the primary internet access and want Equinix Internet Access to be the backup solution in case their main internet connection goes down.
- Management Access – for customers that need an independent, out-of-band channel for managing their servers and network devices collocated in Equinix IBX data centers.
- Use Get Default Settings for Equinix Internet Access with Dedicated Port API request to retrieve default, recommended configuration settings for each of the use cases.
- Primary and backup configurations are fully customizable while the management access supports only default parameter values.
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
Sample curl request
curl -X
POST 'https://api.equinix.com/oauth2/v1/token'
-H 'content-type: application/json'
-d '{
"grant_type": "password",
"client_id": "ABCDE12345",
"client_secret": "FGHIJ67890",
"user_name": "john.doe@example.com",
"user_password": "jd1@#$"
}'
Refer to Generating Client ID and Client Secret for instructions on how to create client ID and client secret. For further details on how to authorize your API requests, see Requesting Access and Refresh tokens.
If you don't know your user credentials for Equinix Customer Portal, contact your local Equinix Service Desk.
Step 2: Get Attribute Information
Determine Equinix Internet Access Availability
Use the Get IBX Data Centers API request to list IBX data centers where Equinix Internet Access is available.
In addition to IBX data centers returned by this API, Equinix Internet Access with Dedicated Port is also available for offline ordering in select Equinix facilities in Bulgaria, China, Poland, and Turkey. To order Equinix Internet Access service in one of those countries, contact your Equinix sales representative.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/ibxs?service.connection.type=IA_C&offset=0&limit=20'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"countryCode": "US",
"region": "AMER",
"metroCode": "DC",
"metroName": "Washington D.C.",
"ibx": "DC5",
"geoCoordinates": {
"latitude": 39.015958,
"longitude": -77.461263
}
}
]
}
Retrieve Billing Information
1. Get billing accounts.
Use Get Accounts API request to get the list of billing accounts available to you for ordering Equinix Internet Access in the given IBX data center.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts?operationalUnits.ibxs.ibx=DC5&offset=0&limit=50'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"accountNumber": "123456",
"accountName": "John Doe",
"billing": {
"signatureRequired": true,
"poExempted": true,
"poBearing": true,
"currency": "USD"
},
"operationalUnits": [
{
"ibxs": [
{
"ibx": "DC5"
}
],
"metros": [
{
"metroCode": "DC"
}
]
}
],
"orgId": "1232",
"organizationName": "Equinix, Inc."
}
]
}
2. Get billing agreements.
Use the Get Account Agreements API request to retrieve a list of agreements between you and Equinix for the given billing account and IBX data center.
Only accounts with valid agreements can be used to order Equinix Internet Access.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts/123456/agreements?ibx=DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 50,
"total": 1
},
"data": [
{
"ibx": "DC5",
"type": "MCA_GTC",
"valid": true
}
]
}
3. Determine Purchase Order Number (Conditional).
Depending on your billing account setup, ordering EIA service may require a valid purchase order number. Use the Get Purchase Orders API request to list purchase orders associated with a given account or create a new purchase order when submitting Equinix Internet Access service order.
Sample curl request - get purchase orders
curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts/123456/purchaseOrders'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 2
},
"data": [
{
"type": "BLANKET_PURCHASE_ORDER",
"number": "10010",
"account": {
"accountNumber": "123123"
},
"categories": [
"INTERCONNECTION"
],
"locations": [
{
"ibx": "WA1"
}
],
"amount": 10000.5,
"startDate": "2023-01-24",
"endDate": "2023-08-24",
"description": "Purchase order desc",
"draft": false,
"status": "ACTIVE",
"currency": "USD"
}
]
}
Sample curl request - include purchase order number creation in Equinix Internet Access service creation request
[...]
"order": {
"referenceNumber": "",
"purchaseOrder": {
"type": "STANDARD_PURCHASE_ORDER",
"number": "PO-1234",
"amount": "100",
"startDate": "2023-02-08",
"endDate": "2023-02-28",
"attachment": {
"attachmentId": "b67ee8b6-a50e-493c-bf6b-750db9429951"
}
},
"signature": {
"signatory": "SELF"
},
"contacts": [
{
"type": "TECHNICAL",
"registeredUser": "JoeAverage"
},
{
"type": "NOTIFICATION",
"registeredUser": "JoeAverage"
}
]
},
[...]
Use the POST Attachments File API request to upload an attachment and obtain its identifier.
Establish Service Parameters
Establish what Equinix Internet Access service configurations are available in the given IBX data center.
1. Determine default service settings.
Use the Get Default Settings for EIA with Dedicated Port API request to retrieve the recommended settings for each of the Equinix Internet Access service use cases.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/dedicatedPortDefaultConfigurations?connection.aside.accessPoint.location.ibx=DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 50,
"total": 3
},
"data": [
{
"type": "DUAL_PORT",
"useCase": "MAIN",
"billing": "FIXED",
"bandwidth": 500,
"connection": {
"aside": {
"accessPoint": {
"location": {
"ibx": "DC5"
},
"port": {
"physicalPortsQuantity": 1,
"physicalPort": {
"speed": 1000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber"
},
"interface": {
"type": "1G SMF"
}
}
}
}
}
},
"routingProtocol": {
"type": "STATIC",
"ipv4": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 29
}
},
"ipv6": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 64
}
}
}
},
{
"type": "SINGLE_PORT",
"useCase": "BACKUP",
"billing": "USAGE_BASED",
"bandwidth": 0,
"connection": {
"aside": {
"accessPoint": {
"location": {
"ibx": "DC5"
},
"port": {
"physicalPortsQuantity": 1,
"physicalPort": {
"speed": 1000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber"
},
"interface": {
"type": "1G SMF"
}
}
}
}
}
},
"routingProtocol": {
"type": "BGP",
"ipv4": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 30
}
},
"ipv6": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 64
}
}
}
},
{
"type": "SINGLE_PORT",
"useCase": "MANAGEMENT_ACCESS",
"billing": "FIXED",
"bandwidth": 15,
"connection": {
"aside": {
"accessPoint": {
"location": {
"ibx": "DC5"
},
"port": {
"physicalPortsQuantity": 1,
"physicalPort": {
"speed": 1000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber"
},
"interface": {
"type": "1G SMF"
}
}
}
}
}
},
"routingProtocol": {
"type": "DIRECT",
"ipv4": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 30
}
},
"ipv6": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 64
}
}
}
}
]
}
Skip to Get Colocation Cages Information if the default configuration fulfills your needs.
2. Get available port configurations.
Use the Get Port Configurations API request to retrieve port options for Equinix Internet Access with Dedicated Port service in a selected IBX data center.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/portConfigurations?connection.aside.accessPoint.port.location.ibx=DC5&useCase=MAIN'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 50,
"total": 2
},
"data": [
{
"useCase": "MAIN",
"type": "SINGLE_PORT",
"routingProtocol": {
"ipv4": {
"enabled": false
},
"ipv6": {
"enabled": true
}
},
"connection": {
"aside": {
"accessPoint": {
"port": {
"location": {
"ibx": "DC5"
},
"physicalPort": {
"interface": {
"type": "1G SMF"
},
"speed": 1000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber"
}
}
}
}
}
}
},
{
"useCase": "MAIN",
"type": "DUAL_PORT",
"routingProtocol": {
"ipv4": {
"enabled": false
},
"ipv6": {
"enabled": false
}
},
"connection": {
"aside": {
"accessPoint": {
"port": {
"location": {
"ibx": "DC5"
},
"physicalPort": {
"interface": {
"type": "100G SMF"
},
"speed": 100000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber"
}
}
}
}
}
}
}
]
}
3. Get available port bandwidth options.
Use the Get Bandwidth Configurations for EIA with Dedicated Port API request to retrieve available port bandwidth options.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/dedicatedBandwidthConfigurations?useCase=MAIN'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1479
},
"data": [
{
"useCase": "MAIN",
"bandwidth": 20,
"billing": "FIXED",
"connection": {
"aside": {
"accessPoint": {
"port": {
"physicalPortsQuantity": 3,
"physicalPort": {
"speed": 10000
}
}
}
}
}
},
{
"useCase": "MAIN",
"bandwidth": 1900,
"billing": "FIXED",
"connection": {
"aside": {
"accessPoint": {
"port": {
"physicalPortsQuantity": 3,
"physicalPort": {
"speed": 10000
}
}
}
}
}
}
]
}
4. Get available routing protocol options.
Use the Get Routing Protocol Configurations API request to retrieve available routing protocol options.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/routingProtocolConfigurations?useCase=MAIN'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 50,
"total": 2
},
"data": [
{
"useCase": "MAIN",
"type": "DUAL_PORT",
"routingProtocol": {
"type": "DIRECT",
"ipv4": {
"customerRoute": {
"importPolicy": "PA"
},
"peering": {
"vrrpEnabled": true,
"peerSubnet": {
"prefixLength": 29,
"quantity": 1
}
}
},
"ipv6": {
"customerRoute": {
"importPolicy": "PA"
},
"peering": {
"vrrpEnabled": true,
"peerSubnet": {
"prefixLength": 64,
"quantity": 1
}
}
}
}
},
{
"useCase": "MAIN",
"type": "SINGLE_PORT",
"routingProtocol": {
"type": "BGP",
"ipv4": {
"customerRoute": {
"importPolicy": "PI"
},
"peering": {
"vrrpEnabled": false,
"peerSubnet": {
"prefixLength": 30,
"quantity": 1
}
}
},
"ipv6": {
"customerRoute": {
"importPolicy": "PI"
},
"peering": {
"vrrpEnabled": false,
"peerSubnet": {
"prefixLength": 64,
"quantity": 1
}
}
}
}
}
]
}
5. Get customer route configurations.
Use the Get Customer Route Configurations API request to retrieve available routing protocol options.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/customerRouteConfigurations?useCase=MAIN'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 481
},
"data": [
{
"useCase": "MAIN",
"routingProtocol": {
"type": "DIRECT",
"ipv4": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 27
},
"peering": {
"vrrpEnabled": true
}
}
},
"type": "DUAL_PORT"
},
{
"useCase": "MAIN",
"routingProtocol": {
"type": "DIRECT",
"ipv4": {
"customerRoute": {
"importPolicy": "PA",
"prefixLength": 24
},
"peering": {
"vrrpEnabled": true
}
}
},
"type": "DUAL_PORT"
}
]
}
Determine Ports Availability
1. Get Colocation Cages Information.
Use the Get Cages API request to retrieve your cages in a given IBX data center and associated with the specified billing account.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/cages?location.ibx=DC5&account.accountNumber=123456'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"number": "20221219_910222",
"spaceId": "DC5:01:20221219_910222",
"cabinetsCount": 2,
"account": {
"accountNumber": "123456"
},
"location": {
"ibx": "DC5"
}
}
]
}
2. Get Cabinets Information.
Use the Get Cabinets API request to retrieve your cabinets in a given cage.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/cabinets?location.ibx=DC5&account.accountNumber=123456&cage.spaceId=DC5:01:20221219_910222'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"number": "Demarc",
"spaceId": "DC5:01:20221219_910222:Demarc",
"patchPanelsCount": 7,
"account": {
"accountNumber": "123456"
},
"cage": {
"spaceId": "DC5:01:20221219_910222"
},
"location": {
"ibx": "DC5"
}
}
]
}
3. Get Patch Panel Details.
Use the Get Patch Panels API request to retrieve patch panels in the specified cabinet and determine which ports are available.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/patchPanels?location.ibx=DC5&account.accountNumber=123456&cage.spaceId=DC5:01:12345_67890&cabinet.spaceId=DC5:01:12345_67890:Demarc'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"number": "CP:Demarc:1266844",
"type": "CUSTOMER_PROVIDED",
"prewired": false,
"availablePortsCount": 4,
"availablePorts": [
1,
10,
100,
101
],
"ownedPortsCount": 0,
"ownedPorts": [],
"mediaTypes": [
"Single-Mode Fiber",
"62.5_MICRON_MULTI_MODE_FIBER",
"OS1",
"50_MICRON_MULTI_MODE_FIBER_OM3",
"62.5_MICRON_MULTI_MODE_FIBER_OM1",
"50_MICRON_MULTI_MODE_FIBER_OM3",
"50_MICRON_MULTI_MODE_FIBER_OM4"
],
"dedicatedMediaType": "FIBER",
"cage": {
"spaceId": "DC5:01:20221219_910222"
},
"cabinet": {
"spaceId": "DC5:01:20221219_910222:Demarc"
},
"location": {
"ibx": "DC5"
},
"account": {
"accountNumber": "123456"
}
}
]
}
Get Connection Services Information
Use the Get Connection Services API request to retrieve connection services applicable to Equinix Internet Access in the specified IBX data center.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/connectionServices?mediaTypes.connectorTypes.locations.ibx=DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"name": "Single-Mode Fiber",
"mediaTypes": [
{
"name": "Single-Mode Fiber",
"connectorTypes": [
{
"name": "LC",
"requiredPorts": 1,
"optionalPorts": 1,
"locations": [
{
"ibx": "DC5"
}
]
},
{
"name": "SC",
"requiredPorts": 2,
"optionalPorts": 0,
"locations": [
{
"ibx": "DC5"
}
]
},
{
"name": "ST",
"requiredPorts": 2,
"optionalPorts": 0,
"locations": [
{
"ibx": "DC5"
}
]
},
{
"name": "FC",
"requiredPorts": 2,
"optionalPorts": 0,
"locations": [
{
"ibx": "DC5"
}
]
}
]
}
]
}
]
}
Determine Contact Information
Placing Equinix Internet Access service order requires contact information for technical inquiries (order.contacts.type: TECHNICAL) and asset's lifecycle notifications (order.contacts.type: NOTIFICATION) purposes. Note that you can provide the same contact person for both.
Use the Get Users API request to retrieve users in your organization.
Sample curl request
curl -X GET 'https://api.equinix.com/access/v2/users?status=ACTIVE'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"data": [
{
"username": "johndoe1",
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@corp.com",
"title": "Manager",
"department": "Procurement",
"status": "ACTIVE",
"securityProfile": "COMPLETED",
"userRole": "USER",
"isFavourite": false,
"activationDateTime": "2021-05-20T13:58:09Z",
"createdDateTime": "2021-05-20T13:58:09Z",
"updatedDateTime": "2021-05-20T14:34:15Z"
}
],
"pagination": {
"offset": 0,
"limit": 1,
"total": 1,
"next": "/users?status=ACTIVE&offset=0&limit=1",
"previous": "/users?status=ACTIVE&offset=0&limit=1"
}
}
Step 3: Get Contractual Context Information
Retrieve Operational Units
Use the Get Operational Units API request to retrieve the information on the legal entity operating the specified IBX data center.
Note that by ordering Equinix Internet Access service instance you enter a legal agreement with the entity that operates a given IBX data center.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/operationalUnits?location.ibx=DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 50,
"total": 1
},
"data": [
{
"name": "EQUINIX - US",
"address": {
"address1": "Equinix LLC, on behalf of itself and its U.S. Affiliates",
"address2": "One Lagoon Drive, 4th Floor",
"city": "Redwood City",
"countryCode": "US",
"country": "United States",
"zipCode": "94065"
},
"location": {
"ibx": "DC5",
"metroCode": "DC"
}
}
]
}
Retrieve Terms and Conditions
Use the Get Terms and Conditions API request to retrieve terms and conditions applicable to your order.
Ordering Equinix Internet Access service instance using the Create Equinix Internet Access Service API request means that you have read and accepted these terms and conditions.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/terms?account.accountNumber=123456&location.ibx=DC5&connectivitySource.type=COLO&product=IA_C'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 50,
"total": 1
},
"data": [
{
"text": "<html>\r\n\t<head>\r\n\t</head>\r\n\t\r\n\t<body>\r\n\t\r\n\t\t<div>\r\n\t\t\tVersion: February 14, 2022[...]</html>",
"version": "a2Z7i000000BgLaEAK",
"location": {
"ibx": "DC5"
},
"account": {
"accountNumber": "200051"
},
"connectivitySource": {
"type": "COLO"
},
"type": "TERMS_AND_CONDITIONS",
"product": "IA_C",
"language": "en"
}
]
}
Get Signature Policies
Depending on your organization's signature policy and billing account attributes, you may be required to sign your order – either digitally (using Adobe Sign) or on paper (wet signature). Signature requirement is determined by the combination of the clickThroughAllowed and billing.signatureRequired attributes, returned by the /signaturePolicies and /accounts endpoints respectively. In case the signature is required, include the order.signature object is the order submission payload.
Signature PolicyclickThroughAllowed | Billing AccountsignatureRequired | Result |
|---|---|---|
| True | True | Order needs to be signed |
| False | False | Order needs to be signed |
| False | True | Order needs to be signed |
| True | False | Order can be submitted without signing |
Use the Get Signature Policies API request to retrieve available signature policies.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/signaturePolicies?location.countryCode=US'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"signature": {
"types": [
"DIGITAL",
"WET"
]
},
"clickThroughAllowed": true,
"location": {
"countryCode": "US"
}
}
]
}
Step 4: Get Price
Use the Retrieve Pricing API request to establish the price of the Equinix Internet Access service in a specified configuration. Note that the price includes a one-time fee and monthly recurring charges.
Sample curl request
curl -X POST 'https://api.equinix.com/internetAccess/v1/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"INTERNET_ACCESS_PRODUCT"
]
},
{
"property": "/account/accountNumber",
"operator": "=",
"values": [
"123456"
]
},
{
"property": "/service/type",
"operator": "=",
"values": [
"SINGLE_PORT"
]
},
{
"property": "/service/useCase",
"operator": "=",
"values": [
"MAIN"
]
},
{
"property": "/service/billing",
"operator": "=",
"values": [
"FIXED"
]
},
{
"property": "/service/connection/type",
"operator": "=",
"values": [
"IA_C"
]
},
{
"property": "/service/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
},
{
"property": "/service/connection/aSide/accessPoint/location/ibx",
"operator": "=",
"values": [
"DC5"
]
},
{
"property": "/service/connection/aSide/accessPoint/port/physicalPort/speed",
"operator": "=",
"values": [
10000
]
},
{
"property": "/service/connection/aSide/accessPoint/port/physicalPortQuantity",
"operator": "=",
"values": [
1
]
}
]
}
}'
Sample response
{
"data": [
{
"href": "https://api.equinix.com/internetAccess/v1/prices/search",
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service",
"account": {
"accountNumber": "123456"
},
"currency": "USD",
"category": "CUSTOMER",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 0.03,
"unit": "GB_1",
"product": {
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service"
}
},
{
"type": "MONTHLY_RECURRING",
"price": 350,
"unit": "ITEM",
"product": {
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service"
}
},
{
"type": "NON_RECURRING",
"price": 1000,
"unit": "ITEM",
"product": {
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service"
}
}
],
"summary": {
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 350,
"unit": "ITEM"
},
{
"type": "NON_RECURRING",
"price": 1000,
"unit": "ITEM"
}
],
"totalCharge": {
"price": 1350
}
},
"service": {
"type": "SINGLE_PORT",
"billing": "USAGE_BASED",
"useCase": "MAIN",
"connection": {
"type": "IA_C",
"aSide": {
"accessPoint": {
"type": "COLO",
"location": {
"ibx": "DC5"
},
"port": {
"physicalPort": {
"speed": 10000
},
"physicalPortQuantity": 1
}
}
}
}
}
}
],
"pagination": {
"offset": 0,
"limit": 50,
"total": 1
}
}
Step 5: Create Equinix Internet Access Service Instance
Use the Create Equinix Internet Access Service API request to create an EIA service instance.
Ordering Equinix Internet Access service instance using the Create Equinix Internet Access Service Instance API request means that you have read and accepted:
- Service terms and conditions. Use the Get Terms and Conditions API request to retrieve terms and conditions applicable to your order.
- Pricing information that you acknowledge and agree, on behalf of the company account specified in this Order (“Customer”), that the Pricing Information obtained using the Get Pricing API request: (1) is calculated pursuant to the Master Country Agreement, Pricing Agreement, or other similar agreement (“Agreement”) effective between Equinix and Customer; and (2) does not include taxes and may vary depending upon the options selected by Customer in the Order and the applicable tax jurisdiction.
Sample curl request - primary internet connection, dual port, fixed billing, signature required - delegated
curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"name": "Web servers",
"description": "Internet connection for Minecraft server.",
"type": "DUAL_PORT",
"useCase": "MAIN",
"billing": "FIXED",
"bandwidth": 500,
"connections": [
{
"type": "IA_C",
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"bandwidth": 1000,
"type": "IA_PORT",
"location": {
"ibx": "DC5"
},
"lag": {
"enabled": false
},
"connectivitySource": {
"type": "COLO"
},
"physicalPorts": [
{
"type": "XF_PHYSICAL_PORT",
"speed": 1000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber",
"connectionService": "Single-Mode Fiber",
"connectorType": "SC",
"cageSpaceId": "DC5:01:20221219_910222",
"cabinetSpaceId": "DC5:01:20221219_910222:Demarc",
"patchPanel": "CP:Demarc:1266844",
"patchPanelPortA": 1,
"patchPanelPortB": 2
}
}
]
}
}
}
},
{
"type": "IA_C",
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"bandwidth": 1000,
"type": "IA_PORT",
"location": {
"ibx": "DC5"
},
"lag": {
"enabled": false
},
"connectivitySource": {
"type": "COLO"
},
"physicalPorts": [
{
"type": "XF_PHYSICAL_PORT",
"speed": 1000,
"demarcationPoint": {
"mediaType": "Single-Mode Fiber",
"connectionService": "Single-Mode Fiber",
"connectorType": "SC",
"cageSpaceId": "DC5:01:20221219_910222",
"cabinetSpaceId": "DC5:01:20221219_910222:Demarc",
"patchPanel": "CP:Demarc:1266844",
"patchPanelPortA": 3,
"patchPanelPortB": 4
}
}
]
}
}
}
}
],
"routingProtocols": [
{
"type": "STATIC",
"ipv4": {
"customerRoutes": [
{
"ipBlock": {
"prefixLength": 30
}
}
]
},
"ipv6": {
"customerRoutes": [
{
"ipBlock": {
"prefixLength": 64
}
}
]
}
}
],
"order": {
"referenceNumber": "",
"signature": {
"signatory": "DELEGATE",
"delegate": {
"email": "someone.else@equinix.com"
}
},
"contacts": [
{
"type": "TECHNICAL",
"registeredUser": "amer-click-po-user"
},
{
"type": "NOTIFICATION",
"registeredUser": "amer-click-po-user"
}
]
},
"account": {
"accountNumber": "123456"
}
}'
Sample response
{
"uuid": "e6b8874f-d1f8-4f94-ad57-96569dd74486",
"type": "DUAL_PORT",
"useCase": "MAIN",
"name": "Web servers",
"description": "Internet connection for web servers."
"bandwidth": 500,
"account": {
"accountNumber": "123456"
},
"billing": "FIXED",
"draft": false,
"order": {
"href": "https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486/orders/4b8df286-5562-41e2-8753-0379eecbe176",
"uuid": "4b8df286-5562-41e2-8753-0379eecbe176",
"type": "AMENDMENT"
},
"state": "PENDING"
}
Use the Get Specified Order API request to monitor your Equinix Internet Access order.
curl -X GET 'https://api.equinix.com/internetAccess/v1/orders/4b8df286-5562-41e2-8753-0379eecbe176'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'