Service v2

Create Equinix Internet Access Service Instance

	POST /internetAccess/v2/services
Method	POST
Endpoint	/internetAccess/v2/services
Headers	authorization, content-type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	tags, type, name, description, connections, routingProtocol, order

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 Network Edge virtual device, static routing

curl -X POST 'https://api.equinix.com/internetAccess/v2/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "connections": [
        "f2e85156-4e5b-43b5-8d5b-40fd58e0d355"
    ],
    "name": "internetAccess",
    "routingProtocol": {
        "type": "STATIC",
        "ipv4": {
            "customerRoutes": [
                {
                    "ipBlock": {
                        "prefixLength": 30
                    }
                }
            ]
        },
        "ipv6": {
            "customerRoutes": [
                {
                    "ipBlock": {
                        "prefixLength": 64
                    }
                }
            ]
        }
    },
    "type": "SINGLE"
}'

Sample curl request - EIA with Network Edge virtual device, static routing, APAC region

curl -X POST 'https://api.equinix.com/internetAccess/v2/services'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "connections": [
        "f2e85156-4e5b-43b5-8d5b-40fd58e0d355"
    ],
    "name": "internetAccess",
    "routingProtocol": {
        "type": "STATIC",
        "ipv4": {
            "customerRoutes": [
                {
                    "ipBlock": {
                        "prefixLength": 30,
                        "addressingPlans": [
                            {
                                "afterThreeMonths": 2,
                                "immediate": 2,
                                "purpose": "I need this very much.",
                                "size": 2
                            }
                        ],
                        "questions": [
                            {
                                "answer": "NO",
                                "type": "PRIVATE_SPACE_CONSIDERED"
                            },
                            {
                                "answer": "NO",
                                "type": "REFUSED_PREVIOUSLY"
                            },
                            {
                                "answer": "NO",
                                "type": "RETURNING_ADDRESS_SPACE"
                            }
                        ]
                    }
                }
            ]
        },
        "ipv6": {
            "customerRoutes": [
                {
                    "ipBlock": {
                        "prefixLength": 64,
                        "addressingPlans": [
                            {
                                "afterThreeMonths": 2,
                                "immediate": 2,
                                "purpose": "I need this very much.",
                                "size": 2
                            }
                        ],
                        "questions": [
                            {
                                "answer": "NO",
                                "type": "PRIVATE_SPACE_CONSIDERED"
                            },
                            {
                                "answer": "NO",
                                "type": "REFUSED_PREVIOUSLY"
                            },
                            {
                                "answer": "NO",
                                "type": "RETURNING_ADDRESS_SPACE"
                            }
                        ]
                    }
                }
            ]
        }
    },
    "type": "SINGLE"
}'

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 - Internet Access Service supported with one connection originating from one access point on the A-side. DUAL - 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 REQUIRED	Name of the service instance. Example: MainInternetPipe
description string OPTIONAL	Description of the service instance. Example: Descriptive description.
connections array[string] REQUIRED	Fabric connections identifiers.
routingProtocol object REQUIRED	Routing protocol 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
ipv4 object OPTIONAL	IP v4 configuration settings.
customerRoute 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.
customerRoute 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.
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.

Sample response

{
    "uuid": "2abfbf60-566d-42e6-b88f-3bf66b4c867c",
    "type": "SINGLE",
    "bandwidth": 10,
    "account": {
        "accountNumber": "12345"
    },
    "changeLog": {
        "createdBy": "890810",
        "createdByFullName": "eqxnfvuser1 eqxnfvuser1",
        "createdByEmail": "eqxnfvuser1@equinix.com",
        "createdDateTime": "2024-03-08T08:57:43.976583868Z",
        "updatedBy": "890810",
        "updatedByFullName": "eqxnfvuser1 eqxnfvuser1",
        "updatedByEmail": "eqxnfvuser1@equinix.com",
        "updatedDateTime": "2024-03-08T08:57:43.976584888Z"
    },
    "links": [
        {
            "href": "https://api.equinix.com/internetAccess/v2/services/2abfbf60-566d-42e6-b88f-3bf66b4c867c",
            "authenticate": false
        }
    ],
    "order": {
        "href": "https://api.equinix.com/internetAccess/v2/orders/06cb0588-0747-4dd0-bd06-83fa3b483b02",
        "uuid": "06cb0588-0747-4dd0-bd06-83fa3b483b02",
        "type": "AMENDMENT"
    },
    "project": {
        "href": "https://api.equinix.com/resourceManager/v2/projects/4f855852-eb47-4721-8e40-b386a3676abf",
        "projectId": "4f855852-eb47-4721-8e40-b386a3676abf"
    },
    "state": "PROVISIONING"
}

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 - Internet Access Service supported with one connection originating from one access point on the A-side. DUAL - 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
account object	Customer billing account.
accountNumber string	Customer billing account number. Example: 123456
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