Order Internet Access with Network Edge
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 with Network Edge is available to organizations onboarded to Equinix Identity and Access Management.
To place an order for Equinix Internet Access with Network Edge:
- Your organization must be transitioned to Equinix Identity and Access Management.
- Your organization has billing accounts available that don't require a purchase order number to place an order.
- Equinix Fabric Manager role must be assigned to the account used to send API requests. For more information, see Assign and Unassign Roles to Users.
- Network Edge Connections Manager and Network Edge Device Manager roles must be assigned to the account used to send API requests. For more information, see Assign and Unassign Roles to Users.
Prerequisites
-
Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.
-
Use the Get IBX Data Centers API request to list IBX data centers where Equinix Internet Access with Network Edge is available.
-
Use the Get Virtual Devices to get information on your virtual devices available in the select metro.
Create a Connection between Network Edge and Internet Access
Use the Create Connection API request to create a Fabric connection between your Network Edge virtual device and the Equinix Internet Access service profile.
- Fabric connection between your Network Edge device and the Equinix Internet Access service profile is provided free of charge.
- When you deprovision your EIA with Network Edge service instance, the associated Fabric connection is also deprovisioned.
- In case the there's an issue with provisioning an EIA service instance, the associated Fabric connection is deprovisioned automatically.
Sample cURL Request:
curl -X POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer <$TOKEN>'
-d '{
"type": "IA_VC",
"name": "connectingToInterwebz",
"bandwidth": 10,
"aSide": {
"accessPoint": {
"type": "VD",
"virtualDevice": {
"type": "EDGE",
"uuid": "abc1854c-9adf-42bd-bbf0-d0f137ccdd1e"
},
"interface": {
"type": "CLOUD",
"id": 3
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"type": "IA_PROFILE",
"uuid": "e8797df8-57aa-4ff9-abc2-5b6025ba8fc6"
},
"location": {
"metroCode": "DC"
}
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"jane@doe.com"
]
}
]
}'
Sample Response:
{
"type": "IA_VC",
"href": "https://uatapi.npclouda.equinix.com/fabric/v4/connections/f2e85156-4e5b-43b5-8d5b-40fd58e0d355",
"uuid": "asdf5156-4e5b-43b5-8d5b-40fd58e0d355",
"name": "connectingToInterwebz",
"operation": {
"providerStatus": "NOT_AVAILABLE",
"equinixStatus": "PROVISIONING"
},
"order": {
"billingTier": "Up to 10 MB"
},
"notifications": [
{
"type": "ALL",
"emails": [
"jane@doe.com"
]
}
],
"changeLog": {
"createdBy": "janeDoe",
"createdByFullName": "Jane Doe",
"createdByEmail": "jane@doe.com",
"createdDateTime": "2024-03-08T08:57:31.252Z",
"updatedBy": "janeDoe",
"updatedByFullName": "Jane Doe",
"updatedByEmail": "jane@doe.com",
"updatedDateTime": "2024-03-08T08:57:31.252Z"
},
"bandwidth": 10,
"redundancy": {
"group": "6cc1f92d-89be-490e-8ecd-14c5ba9df59d",
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"interface": {
"uuid": "e8797df8-57aa-4ff9-abc2-5b6025ba8fc6",
"id": 10,
"type": "CLOUD"
},
"location": {
"metroCode": "DC"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 11205
},
"virtualDevice": {
"uuid": "8af881c8-c14b-47a0-9a71-871593d9531b",
"type": "EDGE"
}
}
},
"zSide": {
"accessPoint": {
"location": {
"metroCode": "DC"
},
"profile": {
"href": "https://uatapi.npclouda.equinix.com/fabric/v4/serviceProfiles/32d81829-0bf8-45d5-84e2-7289a553dbb6",
"type": "IA_PROFILE",
"name": "Equinix Internet Access",
"uuid": "32d81829-0bf8-45d5-84e2-7289a553dbb6"
}
}
}
}
Creating the Service Instance
To create a Internet Access service instance, send a POST request to the /internetAccess/v1/services endpoint. Specify the service details in the body of the request.
Sample cURL Request - single connection, static routing:
curl -X POST 'https://api.equinix.com/internetAccess/v2/services'
-H 'content-type: application/json'
-H 'authorization: Bearer <$TOKEN>'
-d '{
"connections": [
"asdf5156-4e5b-43b5-8d5b-40fd58e0d355"
],
"name": "internetAccess",
"routingProtocol": {
"type": "STATIC",
"ipv4": {
"customerRoutes": [
{
"ipBlock": {
"prefixLength": 30
}
}
]
},
"ipv6": {
"customerRoutes": [
{
"ipBlock": {
"prefixLength": 64
}
}
]
}
},
"type": "SINGLE"
}'
The parameters included in the request bodies are specific to these examples. For a full list of parameters and their descriptions, see the API Reference.
Sample Response:
{
"uuid": "2abfbf60-566d-42e6-b88f-3bf66b4c867c",
"type": "SINGLE",
"bandwidth": 10,
"account": {
"accountNumber": "12345"
},
"changeLog": {
"createdBy": "janeDoe",
"createdByFullName": "Jane Doe",
"createdByEmail": "jane@doe.com",
"createdDateTime": "2024-03-08T08:57:43.976583868Z",
"updatedBy": "janeDoe",
"updatedByFullName": "Jane Doe",
"updatedByEmail": "jane@doe.com",
"updatedDateTime": "2024-03-08T08:57:43.976584888Z"
},
"links": [
{
"href": "https://api.equinix.com/internetAccess/v2/services/2abfbf60-566d-42e6-b88f-3bf66b4c867c",
"authenticate": false
}
],
"order": {
"href": "https://api.equinix.com/internetAccess/v2/orders/06cb0588-0747-4dd0-bd06-83fa3b483b02",
"uuid": "06cb0588-0747-4dd0-bd06-83fa3b483b02",
"type": "AMENDMENT"
},
"project": {
"href": "https://api.equinix.com/resourceManager/v2/projects/4f855852-eb47-4721-8e40-b386a3676abf",
"projectId": "4f855852-eb47-4721-8e40-b386a3676abf"
},
"state": "PROVISIONING"
}
When ordering EIA with Network Edge service instance located in one of our IBX data center in the
APAC region, make sure to add addressingPlans information to the
ipBlock object.
Sample cURL Request - single connection, static routing - APAC region:
curl -X POST 'https://api.equinix.com/internetAccess/v2/services'
-H 'content-type: application/json'
-H 'authorization: Bearer <$TOKEN>'
-d '{
"connections": [
"asdf5156-4e5b-43b5-8d5b-40fd58e0d355"
],
"name": "internetAccess",
"routingProtocol": {
"type": "STATIC",
"ipv4": {
"customerRoutes": [
{
"ipBlock": {
"prefixLength": 30,
"addressingPlans": [
{
"immediate": 2,
"afterThreeMonths": 4,
"size": 4,
"purpose": "Core routers"
}
],
"questions": [
{
"type": "PRIVATE_SPACE_CONSIDERED",
"answer": "NO"
},
{
"type": "REFUSED_PREVIOUSLY",
"answer": "NO"
},
{
"type": "RETURNING_ADDRESS_SPACE",
"answer": "NO"
}
]
}
}
]
},
"ipv6": {
"customerRoutes": [
{
"ipBlock": {
"prefixLength": 64,
"addressingPlans": [
{
"immediate": 2,
"afterThreeMonths": 4,
"size": 4,
"purpose": "Core routers"
}
],
"questions": [
{
"type": "PRIVATE_SPACE_CONSIDERED",
"answer": "NO"
},
{
"type": "REFUSED_PREVIOUSLY",
"answer": "NO"
},
{
"type": "RETURNING_ADDRESS_SPACE",
"answer": "NO"
}
]
}
}
]
}
},
"type": "SINGLE"
}'
Monitoring Your Request
To view the details of your Equinix Internet Access service instance, you can use the Get Specified Equinix Internet Access Service Instance API request.
curl -X GET 'https://api.equinix.com/internetAccess/v1/services/2abfbf60-566d-42e6-b88f-3bf66b4c867c'
-H 'authorization: Bearer <$TOKEN>'
If there is an issue with provisioning an Internet Access service instance, the associated Fabric connection is deprovisioned automatically.