Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Service

Create Equinix Internet Access Service Instance​

 POST /internetAccess/v1/services
MethodPOST
Endpoint/internetAccess/v1/services
Headersauthorization, content-type
Path ParametersNot applicable
Query ParametersNot applicable
Body Parameterstags, type, useCase, name, description, bandwidth, minBandwidthCommit, billing, connections, draft, routingProtocols, order, account

This API request creates an Equinix Internet Access 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 - EIA with Dedicated Port, primary internet connection, dual port, fixed billing, signature not required

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 web servers.",
    "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": "IA_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": "IA_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": "",
        "contacts": [
            {
                "type": "TECHNICAL",
                "registeredUser": "AverageJoe"
            },
            {
                "type": "NOTIFICATION",
                "registeredUser": "AverageJoe"
            }
        ]
    },
    "account": {
        "accountNumber": "123456"
    }
}'

Sample curl request - EIA with Dedicated Port, primary internet connection, single port, fixed billing - APAC region, signature required - self-signed

curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EIA",
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "billing": "FIXED",
    "bandwidth": 500,
    "connections": [
        {
            "type": "IA_C",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "bandwidth": 1000,
                        "type": "IA_PORT",
                        "location": {
                            "ibx": "HK2"
                        },
                        "lag": {
                            "enabled": false
                        },
                        "connectivitySource": {
                            "type": "COLO"
                        },
                        "physicalPorts": [
                            {
                                "type": "IA_PHYSICAL_PORT",
                                "speed": 1000,
                                "demarcationPoint": {
                                    "mediaType": "Single-Mode Fiber",
                                    "connectionService": "Single-Mode Fiber",
                                    "connectorType": "SC",
                                    "cageSpaceId": "HK2:01:001071",
                                    "cabinetSpaceId": "HK2:01:001071:Demarc",
                                    "patchPanel": "PP:Demarc:00001071",
                                    "patchPanelPortA": 86,
                                    "patchPanelPortB": 87
                                }
                            }
                        ]
                    }
                }
            }
        }
    ],
    "routingProtocols": [
        {
            "type": "BGP",
            "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"
                                }
                            ]
                        }
                    }
                ]
            },
            "exportPolicy": "DEFAULT"
        }
    ],
    "order": {
        "referenceNumber": "",
        "signature": {
            "signatory": "SELF"
        },
        "contacts": [
            {
                "type": "TECHNICAL",
                "registeredUser": "AverageJoe"
            },
            {
                "type": "NOTIFICATION",
                "registeredUser": "AverageJoe"
            }
        ]
    },
    "account": {
        "accountNumber": "202518"
    }
}'

Sample curl request - EIA with Dedicated Port, primary internet connection, single port, fixed billing - customer-owned IP address, signature required - delegated

curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EIA",
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "billing": "FIXED",
    "bandwidth": 20,
    "connections": [
        {
            "type": "IA_C",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "bandwidth": 1000,
                        "type": "IA_PORT",
                        "location": {
                            "ibx": "HK2"
                        },
                        "lag": {
                            "enabled": false
                        },
                        "connectivitySource": {
                            "type": "COLO"
                        },
                        "physicalPorts": [
                            {
                                "type": "IA_PHYSICAL_PORT",
                                "speed": 1000,
                                "demarcationPoint": {
                                    "mediaType": "Single-Mode Fiber",
                                    "connectionService": "Single-Mode Fiber",
                                    "connectorType": "SC",
                                    "cageSpaceId": "HK2:01:001071",
                                    "cabinetSpaceId": "HK2:01:001071:Demarc",
                                    "patchPanel": "PP:Demarc:00001071",
                                    "patchPanelPortA": 88,
                                    "patchPanelPortB": 89
                                }
                            }
                        ]
                    }
                }
            }
        }
    ],
    "routingProtocols": [
        {
            "type": "BGP",
            "customerAsn": "123",
            "ipv4": {
                "customerRoutes": [
                    {
                        "prefix": "67.223.84.0/24"
                    }
                ]
            },
            "ipv6": {
                "customerRoutes": [
                    {
                        "prefix": "fd00::/48"
                    }
                ]
            },
            "exportPolicy": "FULL_DEFAULT"
        }
    ],
    "order": {
        "referenceNumber": "",
        "signature": {
            "signatory": "DELEGATE",
            "delegate": {
                "email": "someone.else@equinix.com"
            }
        },
        "contacts": [
            {
                "type": "TECHNICAL",
                "registeredUser": "AverageJoe"
            },
            {
                "type": "NOTIFICATION",
                "registeredUser": "AverageJoe"
            }
        ]
    },
    "account": {
        "accountNumber": "202518"
    }
}'

Sample curl request - EIA with Dedicated Port, primary internet connection, single port, burst billing, direct routing, signature required - self-signed

curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EIA",
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "billing": "BURST_BASED",
    "minBandwidthCommit": 100,
    "bandwidth": 1000,
    "connections": [
        {
            "type": "IA_C",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "bandwidth": 1000,
                        "type": "IA_PORT",
                        "location": {
                            "ibx": "HK1"
                        },
                        "lag": {
                            "enabled": false
                        },
                        "connectivitySource": {
                            "type": "COLO"
                        },
                        "physicalPorts": [
                            {
                                "type": "IA_PHYSICAL_PORT",
                                "speed": 1000,
                                "demarcationPoint": {
                                    "mediaType": "Single-Mode Fiber",
                                    "connectionService": "Single-Mode Fiber",
                                    "connectorType": "SC",
                                    "cageSpaceId": "HK1:13:20221219_910214",
                                    "cabinetSpaceId": "HK1:13:20221219_910214:Demarc",
                                    "patchPanel": "CP:Demarc:1266847",
                                    "patchPanelPortA": 1,
                                    "patchPanelPortB": 2
                                }
                            }
                        ]
                    }
                }
            }
        }
    ],
    "routingProtocols": [
        {
            "type": "DIRECT"
        }
    ],
    "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"
            }
        ]
    },
    "account": {
        "accountNumber": "212171"
    }
}'

Sample curl request - EIA with Fabric, primary internet connection, single port, static routing, fixed billing

 

EIA with Fabric can be ordered using billing accounts that don't require a purchase order to place an order. To identify applicable billing accounts, see Retrieve Billing Information.

curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EIA_Static",
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "billing": "FIXED",
    "bandwidth": 10,
    "connections": [
        {
            "type": "IA_VC",
            "name": "EIA_Static",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "type": "XF_PORT",
                        "uuid": "asdf5dbe-fa39-a399-f7e0-306a5c00af26"
                    },
                    "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1235
                    }
                }
            }
        }
    ],
    "routingProtocols": [
        {
            "type": "STATIC",
            "ipv4": {
                "customerRoutes": [
                    {
                        "ipBlock": {
                            "prefixLength": 28
                        }
                    }
                ]
            },
            "ipv6": {
                "customerRoutes": [
                    {
                        "ipBlock": {
                            "prefixLength": 64
                        }
                    }
                ]
            }
        }
    ],
    "order": {
        "referenceNumber": "customerReference",
        "contacts": [
            {
                "type": "TECHNICAL",
                "registeredUser": "mjscott"
            },
            {
                "type": "NOTIFICATION",
                "registeredUser": "mjscott"
            }
        ]
    },
    "account": {
        "accountNumber": "200001"
    },
    "project": {
        "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1"
    }
}'

Sample curl request - EIA with Fabric, primary internet connection, single port, direct routing, fixed billing

 

EIA with Fabric can be ordered using billing accounts that don't require a purchase order to place an order. To identify applicable billing accounts, see Retrieve Billing Information.

curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EIA_Direct",
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "billing": "FIXED",
    "bandwidth": 10,
    "connections": [
        {
            "type": "IA_VC",
            "name": "EIA_Direct",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "type": "XF_PORT",
                        "uuid": "asdf5dbe-fa39-a399-f7e0-306a5c00af26"
                    },
                    "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1234
                    }
                }
            }
        }
    ],
    "routingProtocols": [
        {
            "type": "DIRECT",
            "ipv4": {
                "customerRoutes": [
                    {
                        "ipBlock": {
                            "prefixLength": 29
                        }
                    }
                ]
            },
            "ipv6": {
                "customerRoutes": [
                    {
                        "ipBlock": {
                            "prefixLength": 48
                        }
                    }
                ]
            }
        }
    ],
    "order": {
        "referenceNumber": "",
        "contacts": [
            {
                "type": "TECHNICAL",
                "registeredUser": "mjscott"
            },
            {
                "type": "NOTIFICATION",
                "registeredUser": "mjscott"
            }
        ]
    },
    "account": {
        "accountNumber": "007"
    },
    "project": {
        "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1"
    }
}'

Sample curl request - EIA with Fabric, primary internet connection, single port, BGP routing, fixed billing

 

EIA with Fabric can be ordered using billing accounts that don't require a purchase order to place an order. To identify applicable billing accounts, see Retrieve Billing Information.

curl -X POST 'https://api.equinix.com/internetAccess/v1/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "EIA_BGP",
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "billing": "FIXED",
    "bandwidth": 10,
    "connections": [
        {
            "type": "IA_VC",
            "name": "EIA_BGP",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "type": "XF_PORT",
                        "uuid": "asdf5dbe-fa39-a399-f7e0-306a5c00af26"
                    },
                    "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1236
                    }
                }
            }
        }
    ],
    "routingProtocols": [
        {
            "type": "BGP",
            "ipv4": {
                "customerRoutes": [
                    {
                        "ipBlock": {
                            "prefixLength": 30
                        }
                    }
                ]
            },
            "ipv6": {
                "customerRoutes": [
                    {
                        "ipBlock": {
                            "prefixLength": 64
                        }
                    }
                ]
            },
            "exportPolicy": "FULL_DEFAULT"
        }
    ],
    "order": {
        "referenceNumber": "",
        "contacts": [
            {
                "type": "TECHNICAL",
                "registeredUser": "mjscott"
            },
            {
                "type": "NOTIFICATION",
                "registeredUser": "mjscott"
            }
        ]
    },
    "account": {
        "accountNumber": "200001"
    },
    "project": {
        "projectId": "asdf320d-866b-4fdf-9b05-dcbe95f43bb1"
    }
}'

Body parameters

Parameter
Description
tags array[string]
OPTIONAL
Additional Equinix Internet Access service instance information.
type string
REQUIRED
Service port type option.
Applicable values:
  • SINGLE_PORT - Internet Access Service supported with one connection originating from one access point on the A-side.
  • DUAL_PORT - Internet Access Service supported with two redundant connections originating from two redundant access points on the A-side and terminating at two redundant internet routers on the Z-side.
useCase string
REQUIRED
Service use case.
Applicable values:
  • MAIN - Primary internet connection.
  • BACKUP - Backup internet connection (applicable to EIA with Dedicated Port).
  • MANAGEMENT_ACCESS - Out-of-band access for assets monitoring and management (applicable to EIA with Dedicated Port).
name string
REQUIRED
Name of the service instance.
Example: MainInternetPipe
description string
OPTIONAL
Description of the service instance.
Example: Descriptive description.
bandwidth integer
REQUIRED
Service bandwidth in Mbps.
Example: 500
minBandwidthCommit integer
OPTIONAL
Minimum bandwidth commitment in Mbps. Applicable to BURST_BASED billing.
Example: 500
billing string
OPTIONAL
Type of billing.
Applicable values:
  • FIXED
  • USAGE_BASED (applicable to EIA with Dedicated Port)
  • BURST_BASED (applicable to EIA with Dedicated Port)
Default: FIXED
connections array[object]
REQUIRED
Collection of service connections.
tags array[string]
OPTIONAL
Additional Equinix Internet Access service instance connection information.
type string
REQUIRED
Connection type.
Applicable values:
  • IA_C - Internet Access service instance with dedicated port.
  • IA_VC - Internet Access service instance with Fabric.
name string
OPTIONAL
Connection name.
Example: MainInternetAccess
description string
OPTIONAL
Connection description.
Example: Access to the interwebz.
aSide object
REQUIRED
A-side connection configuration.
accessPoint object
REQUIRED
Access point configuration.
type string
REQUIRED
Access point type.
Applicable values:
  • COLO - Colocation space in an IBX data center.
port object
REQUIRED
Port configuration.
bandwidth integer
CONDITIONAL
Aggregated ports bandwidth capacity in Mbps.
Applicable to Equinix Internet Access service with dedicated port.
Example: 1000
type string
REQUIRED
Port type.
Applicable values:
  • IA_PORT - Dedicated Internet Access port.
  • XF_PORT - Equinix Fabric port.
uuid string
CONDITIONAL
Fabric port identifier.
Applicable to Equinix Internet Access service with Fabric.
Example: c4d85dbe-fa11-a119-f7e0-306a5c00af26
location object
CONDITIONAL
Port location information.
Applicable to Equinix Internet Access service with dedicated port.
ibx string
REQUIRED
IBX data center identifier.
Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available.
Example: DC5
lag object
CONDITIONAL
Link aggregation configuration.
Applicable to Equinix Internet Access service with dedicated port.
enabled boolean
REQUIRED
Indicates if the port can be a member of a link aggregation group.
Example: false
connectivitySource object
CONDITIONAL
Connection source configuration.
Applicable to Equinix Internet Access service with dedicated port.
type string
REQUIRED
Connection source type.
Applicable values:
  • COLO - Port in your colocation space in an IBX data center.
  • OTHER_CUSTOMER - Port in a third-party's colocation space in an IBX data center.
  • BMMR_EQUINIX_MANAGED - Equinix-managed port in building's meet me room.
  • BMMR_CUSTOMER_MANAGED - Customer-managed port in building's meet me room.
physicalPorts array[object]
CONDITIONAL
Physical ports configuration.
Applicable to Equinix Internet Access service with dedicated port.
type string
REQUIRED
Physical port type.
Applicable values: IA_PHYSICAL_PORT - Dedicated Equinix Internet Access port.
speed integer
REQUIRED
Physical port bandwidth capacity.
Applicable values:
  • 1000
  • 10000
  • 100000
demarcationPoint object
REQUIRED
Connection demarcation point information.
mediaType string
REQUIRED
Connection media type.
Applicable values: Use the Get Connection Services API request to retrieve available connection media types.
Example: Single-Mode Fiber
connectionService string
REQUIRED
Connection service.
Applicable values: Use the Get Connection Services API request to retrieve available connection services.
Example: Single-Mode Fiber
connectorType string
REQUIRED
Physical connector type.
Applicable values: Use the Get Connection Services API request to retrieve available connector types.
Example: SC
cageSpaceId string
REQUIRED
Cage space identifier.
Applicable values: Use the Get Cages API request to retrieve available options.
Example: DC5:01:20221219_910222
cabinetSpaceId string
REQUIRED
Cabinet space identifier.
Applicable values: Use the Get Cabinets API request to retrieve available options.
Example: DC5:01:20221219_910222:Demarc
patchPanel string
REQUIRED
Patch panel identifier.
Applicable values: Use the Get Patch Panels API request to retrieve available options.
Example: PP:Demarc:00001071
patchPanelPortA integer
REQUIRED
Physical port number.
Applicable values: Use the Get Patch Panels API request to retrieve available options.
Example: 86
patchPanelPortB integer
CONDITIONAL
Physical port number. Required for SC, ST, and FC connector types. Optional for the LC connector type.
Applicable values: Use the Get Patch Panels API request to retrieve available options.
Example: 87
linkProtocol object
CONDITIONAL
Link protocol configuration.
Applicable to Equinix Internet Access service with Fabric.
vlanTag integer
CONDITIONAL
DOT1Q protocol VLAN tag.
Applicable to DOT1Q encapsulation type.
Example: 1234
vlanCTag integer
CONDITIONAL
QINQ protocol, inner (customer) VLAN tag.
Applicable to QINQ encapsulation type.
Example: 1234
vlanSTag integer
CONDITIONAL
QINQ protocol, outer (service) VLAN tag.
Applicable to QINQ encapsulation type.
Example: 1234
routingProtocols array[object]
REQUIRED
Routing protocols configuration.
type string
REQUIRED
Routing protocol type.
Applicable values:
  • DIRECT
  • STATIC
  • BGP
name string
OPTIONAL
Name of the routing protocol instance.
Example: WebServers Routes
description string
OPTIONAL
Description of the routing protocol instance.
Example: Routes to customer facing web servers
customerAsn string
OPTIONAL
Your Autonomous System Number. Applicable to customer-owned IP addresses and EIA with Dedicated Port instances that use BGP routing.
Example: 1234
customerAsnRange string
OPTIONAL
32-bit or 16-bit ASN range for Equinix-assigned private ASN. Applicable to customer-owned IP addresses and EIA with Fabric instances that use BGP routing.
Applicable values:
  • BITS_32
  • BITS_16
ipv4 object
OPTIONAL
IP v4 configuration settings.
customerRoutes array[object]
REQUIRED
Routing information.
prefix object
OPTIONAL
IP block information. Applicable to customer-owned IP addresses.
Example: 67.223.84.0/24
ipBlock object
OPTIONAL
IP block information. Applicable if you want to lease an IP block from Equinix.
prefixLength integer
REQUIRED
Network portion of an IP address determining the number of available IP addresses.
Example: 30
addressingPlans array[object]
CONDITIONAL
Additional information on how intend to use the addressing space. Applicable to orders in APAC region that include IP blocks.
immediate integer
REQUIRED
IP addresses required for immediate use.
Example: 2
afterThreeMonths integer
REQUIRED
IP addresses required after three months.
Example: 2
size integer
REQUIRED
Total number of IP addresses required.
Example: 4
purpose string
REQUIRED
Intended use for the given IP block.
Example: Core routers
questions array[object]
CONDITIONAL
Additional information on your IP v4 allocation request. Applicable to orders in APAC region that include IP blocks. Note that you must include answers to all three questions.
type string
REQUIRED
Question definition.
Applicable values:
  • PRIVATE_SPACE_CONSIDERED - Have you considered using a private IP address space?
  • REFUSED_PREVIOUSLY - Has your request been denied previously?
  • RETURNING_ADDRESS_SPACE - Are you returning any IP addressing space?
answer string
REQUIRED
Answer to the specified question.
Applicable values:
  • YES
  • NO
ipv6 object
OPTIONAL
IP v6 configuration settings.
customerRoutes array[object]
REQUIRED
Routing information.
prefix object
OPTIONAL
IP block information. Applicable to customer-owned IP addresses.
Example: fd00::/48
ipBlock object
CONDITIONAL
IP block information. Applicable if you want to lease an IP block from Equinix.
prefixLength integer
REQUIRED
Network portion of an IP address determining the number of available IP addresses.
Example: 48
order object
OPTIONAL		Equinix Internet Access service instance order information.
contacts array[object]
OPTIONAL
Contact information for order processing. Applicable to Equinix Internet Access with dedicated port service orders.
type string
REQUIRED
Contact information category.
Applicable values:
  • NOTIFICATION - Notifications related to asset's lifecycle.
  • TECHNICAL - Contact person for technical inquiries.
  • ORDERING - Contact person for order-related inquiries.
You must provide contact information for TECHNICAL and NOTIFICATION types.
registeredUser string
OPTIONAL
Registered user identifier. Use the Get Users API request to retrieve users in your organization.
Example: AverageJoe
draft boolean
OPTIONAL
Indicates if this is a draft order.
Applicable values: false
purchaseOrder object
CONDITIONAL
Data set containing purchase order information. Depending on your billing account settings, purchase order may be required or optional.
type string
OPTIONAL
Purchase order type.
Applicable values:
  • STANDARD_PURCHASE_ORDER
  • BLANKET_PURCHASE_ORDER
number string
REQUIRED
Purchase order identifier.
Example: PO-1234
amount number
OPTIONAL
Amount.
Example: 10000
startDate string
OPTIONAL
Purchase order's validity start date in YYYY-MM-DD format.
Example: 2013-05-24
endDate string
OPTIONAL
Purchase order's validity and date in YYYY-MM-DD format.
Example: 2013-05-24
description string
OPTIONAL
Purchase order description.
Example: Interconnection budget.
attachment object
OPTIONAL
Purchase order document information.
attachmentId string
OPTIONAL
Attachment document identifier. Use the POST Attachments File API request to upload an attachment and obtain its identifier.
Example: b67ee8b6-a50e-493c-bf6b-750db9429951
referenceNumber string
OPTIONAL
Reference number for the Equinix Internet Access order.
signature object
OPTIONAL
Equinix Internet Access order signature information.
signatory string
REQUIRED
Determines the party responsible for signing the order.
Applicable values:
  • SELF - User placing the order will sign it.
  • DELEGATE - Someone else will be responsible for signing the order.
delegate object
CONDITIONAL
Signatory delegate contact information. Required if the signatory parameter is set to DELEGATE.
firstName string
OPTIONAL
First name of signatory delegate.
Example: Joe
lastName string
OPTIONAL
Last name of signatory delegate.
Example: Average
email string
REQUIRED
Email address that the signature request is sent to.
Example: joe@average.com
tags array[string]
OPTIONAL
Additional Equinix Internet Access service order information.
account object
REQUIRED
Customer billing account information.
accountNumber string
REQUIRED
Customer billing account number.
Applicable values: Use the Get Accounts API request to retrieve accounts that are available for Equinix Internet Access ordering in a given IBX data center.
Example: 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,
    "links": [],
    "order": {
        "href": "https://api.equinix.com/internetAccess/v1/orders/4b8df286-5562-41e2-8753-0379eecbe176",
        "uuid": "4b8df286-5562-41e2-8753-0379eecbe176",
        "type": "AMENDMENT"
    },
    "state": "PENDING"
}

Response payload body description

Parameter
Description
uuid string
Equinix Internet Access service instance identifier.
Example: e6b8874f-d1f8-4f94-ad57-96569dd74486
tags array[string]
Additional Equinix Internet Access service instance information.
Example: servers
type string
Service connectivity options.
Possible values:
  • SINGLE_PORT - Internet Access Service supported with one connection originating from one access point on the A-side.
  • DUAL_PORT - Internet Access Service supported with two redundant connections originating from two redundant access points on the A-side and terminating at two redundant internet routers on the Z-side.
useCase string
Service use case.
Possible values:
  • MAIN - Primary internet connection.
  • BACKUP - Backup internet connection.
  • MANAGEMENT_ACCESS - Out-of-band access for assets monitoring and management
name string
Name of the service instance.
Example: Web servers
description string
Description of the service instance.
Example: Internet connection for web servers.
bandwidth integer
Service bandwidth in Mbps.
Example: 500
minBandwidthCommit integer
Minimum bandwidth commitment in Mbps. Applicable to BURST_BASED billing.
Example: 500
account object
Customer billing account.
accountNumber string
Customer billing account number.
Example: 123456
draft boolean
Indicates if this is a draft order.
Example: false
links array[object]
HATEOAS links specifying possible follow-up interactions.
order object
Equinix Internet Access service instance order information.
href string
An absolute URL that returns the specified Equinix Internet Access service instance order.
Example: https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486/orders/4b8df286-5562-41e2-8753-0379eecbe176
uuid string
Service order identifier.
Example: 4b8df286-5562-41e2-8753-0379eecbe176
type string
Service order type.
Possible values:
  • NEW
  • AMENDMENT
state string
State of service order.
Possible values:
  • DRAFT
  • PENDING
  • PROVISIONING
  • ACTIVE
  • INACTIVE
  • DEPROVISIONING
  • DEPROVISIONED
  • FAILED

Get Specified Equinix Internet Access Service Instance​

 GET /internetAccess/v1/services/{uuid}
MethodGET
Endpoint/internetAccess/v1/services/{uuid}
Headersauthorization, content-type
Path Parametersuuid
Query ParametersNot applicable
Body ParametersNot applicable

This API request returns an EIA service instance.


Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED
Equinix Internet Access service instance identifier.
Example: e6b8874f-d1f8-4f94-ad57-96569dd74486

Sample response

{
    "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64",
    "uuid": "ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64",
    "type": "SINGLE_PORT",
    "name": "EIA dot1q Juniper",
    "bandwidth": 500,
    "billing": "FIXED",
    "state": "ACTIVE",
    "draft": false,
    "useCase": "MAIN",
    "change": {
        "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/changes/07e49217-2575-49c0-bded-7422ea12d7c4",
        "uuid": "07e49217-2575-49c0-bded-7422ea12d7c4",
        "type": "SERVICE_CREATION"
    },
    "changeLog": {
        "createdBy": "890702",
        "createdByFullName": "johnDoe johnDoe",
        "createdByEmail": "johnDoe@nocompany2.com",
        "createdDateTime": "2023-05-09T14:03:38.338900Z",
        "updatedBy": "890702",
        "updatedByFullName": "johnDoe johnDoe",
        "updatedByEmail": "johnDoe@nocompany2.com",
        "updatedDateTime": "2023-05-09T14:03:38.338902Z"
    },
    "connections": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/connections/a8027ab6-57db-4ed4-9f86-9951927fd429",
            "uuid": "a8027ab6-57db-4ed4-9f86-9951927fd429",
            "type": "IA_VC",
            "name": "CONNECTION a8027ab6-57db-4ed4-9f86-9951927fd429",
            "changeLog": {
                "createdBy": "890702",
                "createdByFullName": "johnDoe johnDoe",
                "createdByEmail": "johnDoe@nocompany2.com",
                "createdDateTime": "2023-05-09T14:03:38.338900Z",
                "updatedBy": "890702",
                "updatedByFullName": "johnDoe johnDoe",
                "updatedByEmail": "johnDoe@nocompany2.com",
                "updatedDateTime": "2023-05-09T14:03:38.338902Z"
            },
            "bandwidth": 500,
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "name": "sit-001-200001-CX-DC5-L-Dot1q-STD-10G-PRI-NK-275",
                    "location": {
                        "href": "https://api.equinix.com/internetAccess/v1/ibxs/DC5",
                        "region": "AMER",
                        "metroName": "Ashburn",
                        "metroCode": "DC",
                        "ibx": "DC5"
                    },
                    "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26",
                        "type": "XF_PORT",
                        "uuid": "c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26"
                    },
                    "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 4013
                    }
                }
            },
            "links": []
        }
    ],
    "routingProtocols": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/routingProtocols/7bed33bc-36c4-4a67-9537-9a500cf803e9",
            "uuid": "7bed33bc-36c4-4a67-9537-9a500cf803e9",
            "type": "STATIC",
            "name": "Routing Protocol static",
            "ipv4": {
                "customerRoutes": [
                    {
                        "importPolicy": "PA",
                        "prefix": "51.163.2.128/27",
                        "prefixLength": 27,
                        "ipBlock": {
                            "href": "https://api.equinix.com/internetAccess/v1/ipBlocks/ea07d743-4753-4be6-98bf-de12130b4141",
                            "uuid": "ea07d743-4753-4be6-98bf-de12130b4141",
                            "type": "IA_IP_BLOCK"
                        }
                    }
                ],
                "peerings": [
                    {
                        "connections": [],
                        "customerPeerIps": [
                            "51.163.7.250/30"
                        ],
                        "peerSubnet": {
                            "prefix": "51.163.7.248/30",
                            "prefixLength": 30
                        },
                        "vrrpEnabled": false,
                        "equinixPeerIps": [
                            "51.163.7.249/30"
                        ]
                    }
                ]
            },
            "changeLog": {
                "createdBy": "890702",
                "createdByFullName": "johnDoe johnDoe",
                "createdByEmail": "johnDoe@nocompany2.com",
                "createdDateTime": "2023-05-09T14:03:38.338900Z",
                "updatedBy": "890702",
                "updatedByFullName": "johnDoe johnDoe",
                "updatedByEmail": "johnDoe@nocompany2.com",
                "updatedDateTime": "2023-05-09T14:03:38.338902Z"
            },
            "links": []
        }
    ],
    "account": {
        "href": "https://api.equinix.com/internetAccess/v1/accounts/200001",
        "accountNumber": "200001",
        "accountName": ""
    },
    "project": {
        "href": "https://api.equinix.com/resourceManager/v2/projects/6548320d-866b-4fdf-9b05-dcbe95f43bb1",
        "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1",
        "projectName": "Project-22999",
        "parentOrganizationId": "43ecef86-ec2b-43c9-b7c0-74229e464780",
        "parentOrganizationName": "sit-001-200001a"
    },
    "order": {
        "href": "https://api.equinix.com/internetAccess/v1/orders/bbd5a2bb-9bc8-4e1a-871e-4ee7e00f3ecd",
        "uuid": "bbd5a2bb-9bc8-4e1a-871e-4ee7e00f3ecd",
        "type": "AMENDMENT",
        "draft": false,
        "status": "COMPLETED",
        "changeLog": {
            "createdBy": "890702",
            "createdByFullName": "johnDoe johnDoe",
            "createdByEmail": "johnDoe@nocompany2.com",
            "createdDateTime": "2023-05-09T14:02:27.721774Z",
            "updatedBy": "890702",
            "updatedByFullName": "johnDoe johnDoe",
            "updatedByEmail": "johnDoe@nocompany2.com",
            "updatedDateTime": "2023-05-09T14:02:27.721774Z"
        },
        "number": "1-223399842012",
        "contacts": [
            {
                "href": "https://api.equinix.com/access/v2/users/johnDoe",
                "type": "TECHNICAL",
                "registeredUser": "johnDoe",
                "details": []
            },
            {
                "href": "https://api.equinix.com/access/v2/users/johnDoe",
                "type": "NOTIFICATION",
                "registeredUser": "johnDoe",
                "details": []
            },
            {
                "href": "https://api.equinix.com/access/v2/users/johnDoe",
                "type": "ORDERING",
                "registeredUser": "johnDoe",
                "details": []
            }
        ],
        "links": []
    },
    "links": []
}

Response payload body description

Parameter
Description
href string
An absolute URL that returns the Equinix Internet Access service instance information.
Example: https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec
uuid string
Equinix Internet Access service instance identifier.
Example: df043001-bf0a-446b-a48f-bcdcca68a9f3
type string
Equinix Internet Access service port type option.
Possible values:
  • SINGLE_PORT - Internet Access Service supported with one connection originating from one access point on the A-side.
  • DUAL_PORT - Internet Access Service supported with two redundant connections originating from two redundant access points on the A-side and terminating at two redundant internet routers on the Z-side.
name string
Name of the Equinix Internet Access service instance.
Example: MainInternetPipe
description string
Description of the Equinix Internet Access service instance.
Example: Descriptive description.
bandwidth integer
Service bandwidth in Mbps.
Example: 500
minBandwidthCommit integer
Minimum bandwidth commitment in Mbps. Applicable to BURST_BASED billing.
Example: 500
billing string
Type of billing.
Possible values:
  • FIXED
  • USAGE_BASED
  • BURST_BASED
useCase string
Equinix Internet Access service use case.
Applicable values:
  • MAIN - Primary internet connection.
  • BACKUP - Backup internet connection.
  • MANAGEMENT_ACCESS - Out-of-band access for assets monitoring and management.
change object
Equinix Internet Access service instance change information.
href string
An absolute URL that returns the given Equinix Internet Access service instance change details.
Example: https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/3fa85f64-5717-4562-b3fc-2c963f66afa6
uuid string
Equinix Internet Access service instance change identifier.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type string
Equinix Internet Access service instance change operation type.
Example: SERVICE_CREATION
changeLog object
A permanent record of asset creation, modification, or deletion.
createdBy string
Username of the asset creator.
Example: AverageJoe
createdByFullName string
First and last name of the asset creator.
Example: AverageJoe
createdByEmail string
Email address of the asset creator.
Example: joe@average.com
createdDateTime string
Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
Username of the user that modified the asset.
Example: AverageJoe
updatedByFullName string
First and last name of the user that modified the asset.
Example: Joe Average
updatedByEmail string
Email address of the user that modified the asset.
Example: joe@average.com
updatedDateTime string
Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
deletedBy string
Username of the user that deleted the asset.
Example: AverageJoe
deletedByFullName string
First and last name of the user that deleted the asset.
Example: Joe Average
deletedByEmail string
Email address of the user that deleted the asset.
Example: joe@average.com
deletedDateTime string
Asset deletion timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
connections array[object]
Collection of service connections.
href string
An absolute URL that returns connection information.
Example: https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
uuid string
Connection identifier.
Example: 9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
type string
Connection type.
Possible values:
  • IA_C - Equinix Internet Access with dedicated port service instance.
  • IA_VC - Equinix Internet Access with Fabric service instance.
name string
Connection name.
Example: Primary Connection LD1
description string
Connection description.
Example: Access to the interwebz.
changeLog object
A permanent record of asset creation, modification, or deletion.
bandwidth integer
Connection bandwidth.
Example: 1000
redundancy object
Connection redundancy configuration.
Example: 1000
enabled boolean
Redundancy activation setting.
Example: true
priority string
Relative priority in a redundancy group.
Possible values:
  • PRIMARY
  • SECONDARY
group string
Redundancy group identifier.
Example: f53e34d4-1371-4750-ab83-6c3f2e8b2c43
aSide object
A-side connection configuration.
accessPoint object
Access point configuration.
type string
Access point type.
Possible values:
  • COLO - Colocation space in an IBX data center.
name string
Access point name.
Example: Single-Port-Internet-Access
description string
Access point description.
Example: Highly available access to the internet primary port.
location object
Connection location information.
href string
An absolute URL that returns IBX data center location information.
Example: https://api.equinix.com/internetAccess/v1/ibxs/SV1
region string
Broad geographic area in which a specified asset is located.
Example: AMER
metroName string
Metropolitan area name.
Example: Silicon Valley
metroCode string
Metropolitan area identifier.
Example: SV
ibx string
IBX data center identifier
Example: SV1
port object
Port configuration.
href string
An absolute URL that returns port information.
Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
type string
Port type.
Applicable values:
  • IA_PORT - Dedicated Internet Access port.
  • XF_PORT - Equinix Fabric port.
uuid string
Fabric port identifier.
Applicable to Equinix Internet Access service with Fabric.
Example: a867f685-41b0-1b07-6de0-320a5c00abdd
linkProtocol object
Link protocol configuration.
type string
Link protocol encapsulation type.
Possible values:
  • DOT1Q
  • QINQ
vlanTag integer
DOT1Q protocol VLAN tag.
Example: 1234
vlanCTag integer
QINQ protocol, inner (customer) VLAN tag.
Example: 1234
vlanSTag integer
QINQ protocol, outer (service) VLAN tag.
Example: 1234
virtualDevice object
Virtual device information. Applicable to connections originating from Network Edge virtual devices.
uuid string
Network Edge virtual device identifier.
Example: f53e34d4-1371-4750-ab83-6c3f2e8b2c43
type string
Network Edge virtual device type.
Possible values: EDGE
href integer
An absolute URL that returns device information.
Example: https://api.equinix.com/ne/v1/devices/a867f685-41b0-1b07-6de0-320a5c00abdd
tags array[string]
Additional Equinix Internet Access service instance connection information.
routingProtocols array[object]
Routing protocols configuration.
href string
An absolute URL that returns routing protocol instance configuration.
Example: https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
uuid string
Routing protocol instance identifier.
Example: 9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
type string
Routing protocol type.
Possible values:
  • DIRECT
  • STATIC
  • BGP
name string
Name of the routing protocol instance.
Example: WebServers Routes
description string
Description of the routing protocol instance.
Example: Routes to customer facing web servers
ipv4/ipv6 object
IP v4/v6 configuration settings.
customerRoutes array[object]
Routing information.
importPolicy object
IP addressing import policy information.
prefix object
IP block information. Applicable to customer-owned IP addresses.
Example: 67.223.84.0/24
prefixLength integer
Network portion of an IP address.
Example: 30
ipBlock object
IP block information. Applicable to IP blocks leased from Equinix.
href string
An absolute URL that returns IP block information.
Example: https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8
uuid string
IP block identifier.
Example: 71a1eb68-4daf-4ef0-bd7f-6970727b6fe8
type string
IP block type.
Possible values:
  • IA_IP_BLOCK
peerings array[object]
IP v4/v6 peering configuration.
connections array[object]
IP v4/v6 peering connections.
href string
An absolute URL that returns specified peering connection.
Example: https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1
uuid string
Peering connection identifier.
Example: 38a1eb68-4daf-4ef0-bd7f-6970727b6fc1
type string
Peering connection type.
Possible values:
  • IA_VC
  • IA_C
customerPeerIps array[string]
Customer-side peering IP addresses.
Example: 242.212.207.237
peerSubnet object
Peering subnet configuration.
prefix string
Peering subnet prefix along with the subnet mask in CIDR notation.
Example: 7.7.7.0/30
prefixLength integer
Peering subnet prefix length.
Example: 30
vrrpEnabled boolean
Indicates if the virtual router redundancy protocol is active.
Example: true
equinixPeerIps array[string]
Equinix-side peering IP addresses.
Example: 242.212.207.237
equinixVRRPIp string
Equinix-side VRRP IP addresses.
Example: 121.253.023.201
customerVRRPIp string
Customer-side VRRP IP addresses.
Example: 228.252.12.6
changeLog object
A permanent record of asset creation, modification, or deletion.
tags array[string]
Additional routing protocols information.
links array[object]
HATEOAS links specifying possible follow-up interactions.
account object
Customer account information.
href string
An absolute URL that returns the customer account information.
Example: https://api.equinix.com/internetAccess/v1/accounts/1234
accountNumber string
Customer account number.
Example: 1234533211
accountName string
Name of customer account.
Example: Web Henderson
orgId string
Customer organization identifier.
Example: 1234
organizationName string
Customer organization name.
Example: Joe Average Inc.
project object
Customer project information.
href string
An absolute URL that returns the project information.
Example: https://api.equinix.com/resourceManager/v2/projects/371
projectId string
Project identifier in the customer resource hierarchy.
Example: 123456
projectName string
Project name.
Example: Web Henderson
parentOrganizationId string
Customer organization identifier.
Example: 1234
parentOrganizationName string
Customer organization name.
Example: Joe Average Inc.
order object
Equinix Internet Access service instance order information.
href string
An absolute URL that returns the specified Equinix Internet Access service instance order.
Example: https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486/orders/4b8df286-5562-41e2-8753-0379eecbe176
uuid string
Service order identifier.
Example: 4b8df286-5562-41e2-8753-0379eecbe176
type string
Service order type.
Possible values:
  • NEW
  • AMENDMENT
draft boolean
Indicates a draft order.
Example: false
status string
Service order state.
Possible values:
  • AWAITING_SIGNATURE
  • COMPLETED
  • DRAFT
  • FAILED
  • PROCESSING
  • SIGNATURE_EXPIRED
  • SIGNATURE_REJECTED
  • SUBMITTED
changeLog object
A permanent record of asset creation, modification, or deletion.
number string
Order number.
Example: 1-9234239473
purchaseOrder object
Purchase order number information.
href string
An absolute URL that returns the specified purchase order number information.
Example: https://api.equinix.com/internetAccess/v1/purchaseOrders/32423423
type string
Purchase order type.
Possible values:
  • STANDARD_PURCHASE_ORDER
  • BLANKET_PURCHASE_ORDER
number string
Purchase order number identifier.
Example: 32423423
contacts array[object]
Contact information for order processing and notifications.
href string
An absolute URL that returns user information.
Example: https://api.equinix.com/access/v2/users/john_doe
type string
Contact information category.
Applicable values:
  • NOTIFICATION - Notifications related to asset's lifecycle.
  • TECHNICAL - Contact person for technical inquiries.
  • ORDERING - Contact person for order-related inquiries.
You must provide contact information for TECHNICAL and NOTIFICATION types.
registeredUser string
Registered user identifier.
Example: AverageJoe
tags array[string]
Additional Equinix Internet Access service order information.
links array[object]
HATEOAS links specifying possible follow-up interactions.
tags array[string]
Additional Equinix Internet Access service instance information.
links array[object]
HATEOAS links specifying possible follow-up interactions.

Retrieve Equinix Internet Access Service Instances​

 POST /internetAccess/v1/services/search
MethodPOST
Endpoint/internetAccess/v1/services/search
Headersauthorization, content-type
Path ParametersNot applicable
Query ParametersNot applicable
Body ParametersNot applicable

This API request returns Equinix Internet Access service instances that match the search criteria.

 

This API request returns only instances of Equinix Internet Access with Fabric port.


Sample curl request

curl -X POST 'https://api.equinix.com/internetAccess/v1/services/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/project/projectId",
                "operator": "=",
                "values": [
                    "646712000889547"
                ]
            }
        ]
    }
}'

Body parameters

Parameter
Description
filter object
REQUIRED
Object defining search conditions.
and array[object]
REQUIRED
Array of search parameters.
property string
REQUIRED
Search parameter.
Applicable values:
  • /uuid
  • /name
  • /project/projectId
  • /project/parentOrganizationId
  • /state
operator string
REQUIRED
Search parameter operator.
Applicable values:
  • =
values string
REQUIRED
Search parameter value.
Example: ACTIVE
pagination object
OPTIONAL
Search results pagination settings.
offset integer
OPTIONAL
Index of the first item returned in the response.
Minimum: 0
Default: 0
limit integer
OPTIONAL
Maximum number of items returned per page.
Minimum: 1
Maximum: 100
Default: 20
sort object
OPTIONAL
Search results sorting settings.
direction string
OPTIONAL
Search results sorting direction.
Applicable values:
  • ASC
  • DESC
property string
OPTIONAL
Search results sorting parameter.
Applicable values:
  • /name
  • /state
  • /type

Default: /name
/nameExample:
"property": "/name",
"operator": "=",
"values": [
    "myFavoriteEquinixInternetConnection"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
Equinix Internet Access service instance name.
Example: ["myFavoriteEquinixInternetConnection"]
/uuidExample:
"property": "/uuid",
"operator": "=",
"values": [
    "3a58dd05-f46d-4b1d-a154-2e85c396ea62"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
Equinix Internet Access service instance identifier.
Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]
/project/projectIdExample:
"property": "/project/projectId",
"operator": "=",
"values": [
    "12345"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
Project identifier in the customer resource hierarchy.
Example: ["12345"]
/project/parentOrganizationIdExample:
"property": "/project/parentOrganizationId",
"operator": "=",
"values": [
    "646712000889547"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
Parent organization identifier.
Example: ["646712000889547"]
/stateExample:
"property": "/state",
"operator": "=",
"values": [
    "ACTIVE"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
Equinix Internet Access service instance lifecycle stage.
Applicable values:
  • ACTIVE
  • DEPROVISIONED
  • DEPROVISIONING
  • DRAFT
  • FAILED
  • INACTIVE
  • PENDING
  • PROVISIONING

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 2
    },
    "sort": [
        {
            "direction": "ASC",
            "property": "/name"
        }
    ],
    "data": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64",
            "uuid": "ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64",
            "type": "SINGLE_PORT",
            "name": "EIA dot1q Juniper",
            "bandwidth": 50,
            "billing": "FIXED",
            "state": "ACTIVE",
            "draft": false,
            "useCase": "MAIN",
            "change": {
                "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/changes/07e49217-2575-49c0-bded-7422ea12d7c4",
                "uuid": "07e49217-2575-49c0-bded-7422ea12d7c4",
                "type": "SERVICE_CREATION"
            },
            "changeLog": {
                "createdBy": "890702",
                "createdByFullName": "johnDoe johnDoe",
                "createdByEmail": "johnDoe@nocompany2.com",
                "createdDateTime": "2023-05-09T14:03:38.338900Z",
                "updatedBy": "890702",
                "updatedByFullName": "johnDoe johnDoe",
                "updatedByEmail": "johnDoe@nocompany2.com",
                "updatedDateTime": "2023-05-09T14:03:38.338902Z"
            },
            "connections": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/connections/a8027ab6-57db-4ed4-9f86-9951927fd429",
                    "uuid": "a8027ab6-57db-4ed4-9f86-9951927fd429",
                    "type": "IA_VC",
                    "name": "CONNECTION a8027ab6-57db-4ed4-9f86-9951927fd429",
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-09T14:03:38.338900Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-09T14:03:38.338902Z"
                    },
                    "bandwidth": 50,
                    "aSide": {
                        "accessPoint": {
                            "type": "COLO",
                            "name": "sit-001-200001-CX-DC5-L-Dot1q-STD-10G-PRI-NK-275",
                            "location": {
                                "href": "https://api.equinix.com/internetAccess/v1/ibxs/DC5",
                                "region": "AMER",
                                "metroName": "Ashburn",
                                "metroCode": "DC",
                                "ibx": "DC5"
                            },
                            "port": {
                                "href": "https://api.equinix.com/fabric/v4/ports/c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26",
                                "type": "XF_PORT",
                                "uuid": "c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26"
                            },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 4013
                            }
                        }
                    },
                    "links": []
                }
            ],
            "routingProtocols": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/routingProtocols/7bed33bc-36c4-4a67-9537-9a500cf803e9",
                    "uuid": "7bed33bc-36c4-4a67-9537-9a500cf803e9",
                    "type": "STATIC",
                    "name": "Routing Protocol static",
                    "ipv4": {
                        "customerRoutes": [
                            {
                                "importPolicy": "PA",
                                "prefix": "51.163.2.128/27",
                                "prefixLength": 27,
                                "ipBlock": {
                                    "href": "https://api.equinix.com/internetAccess/v1/ipBlocks/ea07d743-4753-4be6-98bf-de12130b4141",
                                    "uuid": "ea07d743-4753-4be6-98bf-de12130b4141",
                                    "type": "IA_IP_BLOCK"
                                }
                            }
                        ],
                        "peerings": [
                            {
                                "connections": [],
                                "customerPeerIps": [
                                    "51.163.7.250/30"
                                ],
                                "peerSubnet": {
                                    "prefix": "51.163.7.248/30",
                                    "prefixLength": 30
                                },
                                "vrrpEnabled": false,
                                "equinixPeerIps": [
                                    "51.163.7.249/30"
                                ]
                            }
                        ]
                    },
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-09T14:03:38.338900Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-09T14:03:38.338902Z"
                    },
                    "links": []
                }
            ],
            "account": {
                "href": "https://api.equinix.com/internetAccess/v1/accounts/200001",
                "accountNumber": "200001",
                "accountName": ""
            },
            "project": {
                "href": "https://api.equinix.com/resourceManager/v2/projects/6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectName": "Project-22999",
                "parentOrganizationId": "43ecef86-ec2b-43c9-b7c0-74229e464780",
                "parentOrganizationName": "sit-001-200001a"
            },
            "order": {
                "href": "https://api.equinix.com/internetAccess/v1/orders/bbd5a2bb-9bc8-4e1a-871e-4ee7e00f3ecd",
                "uuid": "bbd5a2bb-9bc8-4e1a-871e-4ee7e00f3ecd",
                "type": "AMENDMENT",
                "draft": false,
                "status": "COMPLETED",
                "changeLog": {
                    "createdBy": "890702",
                    "createdByFullName": "johnDoe johnDoe",
                    "createdByEmail": "johnDoe@nocompany2.com",
                    "createdDateTime": "2023-05-09T14:02:27.721774Z",
                    "updatedBy": "890702",
                    "updatedByFullName": "johnDoe johnDoe",
                    "updatedByEmail": "johnDoe@nocompany2.com",
                    "updatedDateTime": "2023-05-09T14:02:27.721774Z"
                },
                "number": "1-223399842012",
                "contacts": [
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "TECHNICAL",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "NOTIFICATION",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "ORDERING",
                        "registeredUser": "johnDoe",
                        "details": []
                    }
                ],
                "links": []
            },
            "links": []
        },
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e",
            "uuid": "1416e55b-f9ee-4867-9ebe-e785a0295d7e",
            "type": "SINGLE_PORT",
            "name": "EIA dot1q Juniper",
            "bandwidth": 50,
            "billing": "FIXED",
            "state": "ACTIVE",
            "draft": false,
            "useCase": "MAIN",
            "change": {
                "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e/changes/3026b1ff-7e94-436f-a737-b71b1ae2312b",
                "uuid": "3026b1ff-7e94-436f-a737-b71b1ae2312b",
                "type": "SERVICE_CREATION"
            },
            "changeLog": {
                "createdBy": "890702",
                "createdByFullName": "johnDoe johnDoe",
                "createdByEmail": "johnDoe@nocompany2.com",
                "createdDateTime": "2023-05-10T11:26:55.038309Z",
                "updatedBy": "890702",
                "updatedByFullName": "johnDoe johnDoe",
                "updatedByEmail": "johnDoe@nocompany2.com",
                "updatedDateTime": "2023-05-10T11:26:55.038311Z"
            },
            "connections": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e/connections/b8ea019b-ee47-44c4-9442-006e34ba8f82",
                    "uuid": "b8ea019b-ee47-44c4-9442-006e34ba8f82",
                    "type": "IA_VC",
                    "name": "CONNECTION b8ea019b-ee47-44c4-9442-006e34ba8f82",
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-10T11:26:55.038309Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-10T11:26:55.038311Z"
                    },
                    "bandwidth": 50,
                    "aSide": {
                        "accessPoint": {
                            "type": "COLO",
                            "name": "sit-001-200001-CX-DC5-L-Dot1q-STD-10G-PRI-NK-275",
                            "location": {
                                "href": "https://api.equinix.com/internetAccess/v1/ibxs/DC5",
                                "region": "AMER",
                                "metroName": "Ashburn",
                                "metroCode": "DC",
                                "ibx": "DC5"
                            },
                            "port": {
                                "href": "https://api.equinix.com/fabric/v4/ports/c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26",
                                "type": "XF_PORT",
                                "uuid": "c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26"
                            },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 4015
                            }
                        }
                    },
                    "links": []
                }
            ],
            "routingProtocols": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e/routingProtocols/d72885ad-3ebc-4856-b5f6-529ee8c29b0c",
                    "uuid": "d72885ad-3ebc-4856-b5f6-529ee8c29b0c",
                    "type": "STATIC",
                    "name": "Routing Protocol static",
                    "ipv4": {
                        "customerRoutes": [
                            {
                                "importPolicy": "PA",
                                "prefix": "142.215.114.0/27",
                                "prefixLength": 27,
                                "ipBlock": {
                                    "href": "https://api.equinix.com/internetAccess/v1/ipBlocks/b7cc54e6-3f31-488a-ab98-51e02f64d8ad",
                                    "uuid": "b7cc54e6-3f31-488a-ab98-51e02f64d8ad",
                                    "type": "IA_IP_BLOCK"
                                }
                            }
                        ],
                        "peerings": [
                            {
                                "connections": [],
                                "customerPeerIps": [
                                    "142.215.188.118/30"
                                ],
                                "peerSubnet": {
                                    "prefix": "142.215.188.116/30",
                                    "prefixLength": 30
                                },
                                "vrrpEnabled": false,
                                "equinixPeerIps": [
                                    "142.215.188.117/30"
                                ]
                            }
                        ]
                    },
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-10T11:26:55.038309Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-10T11:26:55.038311Z"
                    },
                    "links": []
                }
            ],
            "account": {
                "href": "https://api.equinix.com/internetAccess/v1/accounts/200001",
                "accountNumber": "200001",
                "accountName": ""
            },
            "project": {
                "href": "https://api.equinix.com/resourceManager/v2/projects/6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectName": "Project-22999",
                "parentOrganizationId": "43ecef86-ec2b-43c9-b7c0-74229e464780",
                "parentOrganizationName": "sit-001-200001a"
            },
            "order": {
                "href": "https://api.equinix.com/internetAccess/v1/orders/960643a1-0983-476e-a3da-e4fc2952ec39",
                "uuid": "960643a1-0983-476e-a3da-e4fc2952ec39",
                "type": "AMENDMENT",
                "draft": false,
                "status": "COMPLETED",
                "changeLog": {
                    "createdBy": "890702",
                    "createdByFullName": "johnDoe johnDoe",
                    "createdByEmail": "johnDoe@nocompany2.com",
                    "createdDateTime": "2023-05-10T11:25:03.318122Z",
                    "updatedBy": "890702",
                    "updatedByFullName": "johnDoe johnDoe",
                    "updatedByEmail": "johnDoe@nocompany2.com",
                    "updatedDateTime": "2023-05-10T11:25:03.318122Z"
                },
                "number": "1-223573608868",
                "contacts": [
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "TECHNICAL",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "NOTIFICATION",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "ORDERING",
                        "registeredUser": "johnDoe",
                        "details": []
                    }
                ],
                "links": []
            },
            "links": []
        }
        
    ]
}

Response payload body description

Parameter
Description
pagination object
Search results pagination settings.
offset integer
Index of the first item returned in the response.
Example: 0
limit integer
Maximum number of items returned per page.
Example: 20
total integer
Total number of items returned.
Example: 10
sort object
Search results sorting settings.
direction integer
Search results sorting direction.
Example: ASC
property integer
Search results sorting parameter.
Example: /name
data array[object]
Data array containing search results.
href string
An absolute URL that returns the Equinix Internet Access service instance information.
Example: https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec
uuid string
Equinix Internet Access service instance identifier.
Example: df043001-bf0a-446b-a48f-bcdcca68a9f3
type string
Equinix Internet Access service port type option.
Possible values:
  • SINGLE_PORT - Internet Access Service supported with one connection originating from one access point on the A-side.
  • DUAL_PORT - Internet Access Service supported with two redundant connections originating from two redundant access points on the A-side and terminating at two redundant internet routers on the Z-side.
name string
Name of the Equinix Internet Access service instance.
Example: MainInternetPipe
description string
Description of the Equinix Internet Access service instance.
Example: Descriptive description.
bandwidth integer
Service bandwidth in Mbps.
Example: 500
minBandwidthCommit integer
Minimum bandwidth commitment in Mbps. Applicable to BURST_BASED billing.
Example: 500
billing string
Type of billing.
Possible values:
  • FIXED
  • USAGE_BASED
  • BURST_BASED
useCase string
Equinix Internet Access service use case.
Applicable values:
  • MAIN - Primary internet connection.
  • BACKUP - Backup internet connection.
  • MANAGEMENT_ACCESS - Out-of-band access for assets monitoring and management.
change object
Equinix Internet Access service instance change information.
href string
An absolute URL that returns the given Equinix Internet Access service instance change details.
Example: https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/3fa85f64-5717-4562-b3fc-2c963f66afa6
uuid string
Equinix Internet Access service instance change identifier.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type string
Equinix Internet Access service instance change operation type.
Example: SERVICE_CREATION
changeLog object
A permanent record of asset creation, modification, or deletion.
createdBy string
Username of the asset creator.
Example: AverageJoe
createdByFullName string
First and last name of the asset creator.
Example: AverageJoe
createdByEmail string
Email address of the asset creator.
Example: joe@average.com
createdDateTime string
Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
Username of the user that modified the asset.
Example: AverageJoe
updatedByFullName string
First and last name of the user that modified the asset.
Example: Joe Average
updatedByEmail string
Email address of the user that modified the asset.
Example: joe@average.com
updatedDateTime string
Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
deletedBy string
Username of the user that deleted the asset.
Example: AverageJoe
deletedByFullName string
First and last name of the user that deleted the asset.
Example: Joe Average
deletedByEmail string
Email address of the user that deleted the asset.
Example: joe@average.com
deletedDateTime string
Asset deletion timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
connections array[object]
Collection of service connections.
href string
An absolute URL that returns connection information.
Example: https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
uuid string
Connection identifier.
Example: 9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
type string
Connection type.
Possible values:
  • IA_C - Equinix Internet Access service instance with dedicated port.
  • IA_VC - Equinix Internet Access service instance with Fabric.
name string
Connection name.
Example: Primary Connection LD1
description string
Connection description.
Example: Access to the interwebz.
changeLog object
A permanent record of asset creation, modification, or deletion.
bandwidth integer
Connection bandwidth.
Example: 1000
redundancy object
Connection redundancy configuration.
Example: 1000
enabled boolean
Redundancy activation setting.
Example: true
priority string
Relative priority in a redundancy group.
Possible values:
  • PRIMARY
  • SECONDARY
group string
Redundancy group identifier.
Example: f53e34d4-1371-4750-ab83-6c3f2e8b2c43
aSide object
A-side connection configuration.
accessPoint object
Access point configuration.
type string
Access point type.
Possible values:
  • COLO - Colocation space in an IBX data center.
name string
Access point name.
Example: Single-Port-Internet-Access
description string
Access point description.
Example: Highly available access to the internet primary port.
location object
Connection location information.
href string
An absolute URL that returns IBX data center location information.
Example: https://api.equinix.com/internetAccess/v1/ibxs/SV1
region string
Broad geographic area in which a specified asset is located.
Example: AMER
metroName string
Metropolitan area name.
Example: Silicon Valley
metroCode string
Metropolitan area identifier.
Example: SV
ibx string
IBX data center identifier
Example: SV1
port object
Port configuration.
href string
An absolute URL that returns port information.
Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
type string
Port type.
Applicable values:
  • IA_PORT - Dedicated Internet Access port.
  • XF_PORT - Equinix Fabric port.
uuid string
Fabric port identifier.
Applicable to Equinix Internet Access service with Fabric.
Example: a867f685-41b0-1b07-6de0-320a5c00abdd
linkProtocol object
Link protocol configuration.
type string
Link protocol encapsulation type.
Possible values:
  • DOT1Q
  • QINQ
vlanTag integer
DOT1Q protocol VLAN tag.
Example: 1234
vlanCTag integer
QINQ protocol, inner (customer) VLAN tag.
Example: 1234
vlanSTag integer
QINQ protocol, outer (service) VLAN tag.
Example: 1234
virtualDevice object
Virtual device information. Applicable to connections originating from Network Edge virtual devices.
uuid string
Network Edge virtual device identifier.
Example: f53e34d4-1371-4750-ab83-6c3f2e8b2c43
type string
Network Edge virtual device type.
Possible values: EDGE
href string
An absolute URL that returns device information.
Example: https://api.equinix.com/ne/v1/devices/a867f685-41b0-1b07-6de0-320a5c00abdd
tags array[string]
Additional Equinix Internet Access service instance connection information.
routingProtocols array[object]
Routing protocols configuration.
href string
An absolute URL that returns routing protocol instance configuration.
Example: https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
uuid string
Routing protocol instance identifier.
Example: 9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81
type string
Routing protocol type.
Possible values:
  • DIRECT
  • STATIC
  • BGP
name string
Name of the routing protocol instance.
Example: WebServers Routes
description string
Description of the routing protocol instance.
Example: Routes to customer facing web servers
ipv4/ipv6 object
IP v4/v6 configuration settings.
customerRoutes array[object]
Routing information.
importPolicy object
IP addressing import policy information.
prefix object
IP block information. Applicable to customer-owned IP addresses.
Example: 67.223.84.0/24
prefixLength integer
Network portion of an IP address.
Example: 30
ipBlock object
IP block information. Applicable to IP blocks leased from Equinix.
href string
An absolute URL that returns IP block information.
Example: https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8
uuid string
IP block identifier.
Example: 71a1eb68-4daf-4ef0-bd7f-6970727b6fe8
type string
IP block type.
Possible values:
  • IA_IP_BLOCK
peerings array[object]
IP v4/v6 peering configuration.
connections array[object]
IP v4/v6 peering connections.
href string
An absolute URL that returns specified peering connection.
Example: https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1
uuid string
Peering connection identifier.
Example: 38a1eb68-4daf-4ef0-bd7f-6970727b6fc1
type string
Peering connection type.
Possible values:
  • IA_VC
  • IA_C
customerPeerIps array[string]
Customer-side peering IP addresses.
Example: 242.212.207.237
peerSubnet object
Peering subnet configuration.
prefix string
Peering subnet prefix along with the subnet mask in CIDR notation.
Example: 7.7.7.0/30
prefixLength integer
Peering subnet prefix length.
Example: 30
vrrpEnabled boolean
Indicates if the virtual router redundancy protocol is active.
Example: true
equinixPeerIps array[string]
Equinix-side peering IP addresses.
Example: 242.212.207.237
equinixVRRPIp string
Equinix-side VRRP IP addresses.
Example: 121.253.023.201
customerVRRPIp string
Customer-side VRRP IP addresses.
Example: 228.252.12.6
changeLog object
A permanent record of asset creation, modification, or deletion.
tags array[string]
Additional routing protocols information.
links array[object]
HATEOAS links specifying possible follow-up interactions.
account object
Customer account information.
href string
An absolute URL that returns the customer account information.
Example: https://api.equinix.com/internetAccess/v1/accounts/1234
accountNumber string
Customer account number.
Example: 1234533211
accountName string
Name of customer account.
Example: Web Henderson
orgId string
Customer organization identifier.
Example: 1234
organizationName string
Customer organization name.
Example: Joe Average Inc.
project object
Customer project information.
href string
An absolute URL that returns the project information.
Example: https://api.equinix.com/resourceManager/v2/projects/371
projectId string
Project identifier in the customer resource hierarchy.
Example: 123456
projectName string
Project name.
Example: Web Henderson
parentOrganizationId string
Customer organization identifier.
Example: 1234
parentOrganizationName string
Customer organization name.
Example: Joe Average Inc.
order object
Equinix Internet Access service instance order information.
href string
An absolute URL that returns the specified Equinix Internet Access service instance order.
Example: https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486/orders/4b8df286-5562-41e2-8753-0379eecbe176
uuid string
Service order identifier.
Example: 4b8df286-5562-41e2-8753-0379eecbe176
type string
Service order type.
Possible values:
  • NEW
  • AMENDMENT
draft boolean
Indicates a draft order.
Example: false
status string
Service order state.
Possible values:
  • AWAITING_SIGNATURE
  • COMPLETED
  • DRAFT
  • FAILED
  • PROCESSING
  • SIGNATURE_EXPIRED
  • SIGNATURE_REJECTED
  • SUBMITTED
changeLog object
A permanent record of asset creation, modification, or deletion.
number string
Order number.
Example: 1-9234239473
purchaseOrder object
Purchase order number information.
href string
An absolute URL that returns the specified purchase order number information.
Example: https://api.equinix.com/internetAccess/v1/purchaseOrders/32423423
type string
Purchase order type.
Possible values:
  • STANDARD_PURCHASE_ORDER
  • BLANKET_PURCHASE_ORDER
number string
Purchase order number identifier.
Example: 32423423
contacts array[object]
Contact information for order processing and notifications.
In case of Equinix Internet Access with Fabric, contact information is populated automatically with the username of the user account used to obtain access token.
href string
An absolute URL that returns user information.
Example: https://api.equinix.com/access/v2/users/john_doe
type string
Contact information category.
Applicable values:
  • NOTIFICATION - Notifications related to asset's lifecycle.
  • TECHNICAL - Contact person for technical inquiries.
  • ORDERING - Contact person for order-related inquiries.
You must provide contact information for TECHNICAL and NOTIFICATION types.
registeredUser string
Registered user identifier.
Example: AverageJoe
tags array[string]
Additional Equinix Internet Access service order information.
links array[object]
HATEOAS links specifying possible follow-up interactions.
tags array[string]
Additional Equinix Internet Access service instance information.
links array[object]
HATEOAS links specifying possible follow-up interactions.

Delete Equinix Internet Access Service Instance​

 DELETE /internetAccess/v1/services/{uuid}
MethodDELETE
Endpoint/internetAccess/v1/services/{uuid}
Headersauthorization
Path Parametersuuid
Query ParametersdryRun
Body ParametersNot applicable

This API request deprovisions an EIA service instance.

 

Currently, you can deprovision Equinix Internet Access with Fabric and Equinix Internet Access with Network Edge service instances only. To deprovision an Equinix Internet Access with Dedicated Port service instance, contact Equinix Service Desk.


Sample curl request

curl -X DELETE 'https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED		Equinix Internet Access service instance identifier.
Applicable values: Use the Retrieve Equinix Internet Access Service Instances API request to determine the service instance identifier.

You can deprovision service instances in COMPLETED order status and the following service instance status: ACTIVE, DRAFT, INACTIVE, PENDING.

Example: e6b8874f-d1f8-4f94-ad57-96569dd74486

Query parameters

Parameter
Description
dryRun boolean
OPTIONAL		If set to true, the API request is executed in test mode to determine if the user account has sufficient permissions to delete the given service instance.
Example: true

Sample response

{
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "name": "Schrute Server Farms Connection",
    "bandwidth": 500,
    "uuid": "31c30c26-548e-4056-b92a-a15dd3cc6aae",
    "account": {
        "accountNumber": "200491"
    },
    "billing": "FIXED",
    "changeLog": {
        "createdBy": "890751",
        "createdByFullName": "Michael Scott",
        "createdByEmail": "michael.scott@paper.co",
        "createdDateTime": "2023-07-28T06:19:17.614892Z",
        "updatedBy": "890751",
        "updatedByFullName": "Pam Halpert",
        "updatedByEmail": "pam.halpert@paper.co",
        "updatedDateTime": "2023-07-28T06:19:17.614897Z",
        "deletedByFullName": "johnDoe johnDoe",
        "deletedByEmail": "johnDoe@nocompany2.com",
        "deletedDateTime": "2023-09-09T12:34:56.038311Z"
    },
    "draft": false,
    "links": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/31c30c26-548e-4056-b92a-a15dd3cc6aae",
            "authenticate": false
        }
    ],
    "order": {
        "href": "https://api.equinix.com/internetAccess/v1/orders/d78b048c-0ccb-4158-a6e0-2c4cc752f806",
        "uuid": "d78b048c-0ccb-4158-a6e0-2c4cc752f806",
        "type": "AMENDMENT"
    },
    "project": {
        "href": "https://api.equinix.com/resourceManager/v1/projects/ad419c0f-bb03-45be-9753-e828c555fea9",
        "projectId": "ad419c0f-bb03-45be-9753-e828c555fea9"
    },
    "state": "DEPROVISIONING"
}

Response payload body description

Parameter
Description
type string
Service connectivity options.
Possible values:
  • SINGLE_PORT - Internet Access Service supported with one connection originating from one access point on the A-side.
  • DUAL_PORT - Internet Access Service supported with two redundant connections originating from two redundant access points on the A-side and terminating at two redundant internet routers on the Z-side.
useCase string
Service use case.
Possible values:
  • MAIN - Primary internet connection.
  • BACKUP - Backup internet connection.
  • MANAGEMENT_ACCESS - Out-of-band access for assets monitoring and management.
name string
Name of the service instance.
Example: Web servers
description string
Description of the service instance.
Example: Internet connection for web servers.
bandwidth integer
Service bandwidth in Mbps.
Example: 500
minBandwidthCommit integer
Minimum bandwidth commitment in Mbps. Applicable to BURST_BASED billing.
Example: 500
uuid string
Equinix Internet Access service instance identifier.
Example: e6b8874f-d1f8-4f94-ad57-96569dd74486
account object
Customer billing account.
accountNumber string
Customer billing account number.
Example: 123456
billing string
Type of billing
Example: FIXED
changeLog object
A permanent record of asset creation, modification, or deletion.
draft boolean
Indicates if this is a draft order.
Example: false
links array[object]
HATEOAS links specifying possible follow-up interactions.
order object
Equinix Internet Access service instance order information.
href string
An absolute URL that returns the specified Equinix Internet Access service instance order.
Example: https://api.equinix.com/internetAccess/v1/services/e6b8874f-d1f8-4f94-ad57-96569dd74486/orders/4b8df286-5562-41e2-8753-0379eecbe176
uuid string
Service order identifier.
Example: 4b8df286-5562-41e2-8753-0379eecbe176
type string
Service order type.
Possible values:
  • NEW
  • AMENDMENT
project object
Customer project information.
href string
An absolute URL that returns the project information.
Example: https://api.equinix.com/resourceManager/v2/projects/371
projectId string
Project identifier in the customer resource hierarchy.
Example: 123456
state string
State of service order.
Possible values:
  • DRAFT
  • PENDING
  • PROVISIONING
  • ACTIVE
  • INACTIVE
  • DEPROVISIONING
  • DEPROVISIONED
  • FAILED