Equinix Internet Access API (2.4)

Download OpenAPI specification:Download

Equinix API Support: api-support@equinix.com URL: https://docs.equinix.com/api-support.htm License: Equinix Inc Terms of Service

Equinix Internet Access provides direct access to the Internet with scalable bandwidth options in IBX data centers.

Find more information on Equinix Developer Portal

Product Availability

IBXs where Equinix Internet Access is available

Returns IBXs where EIA is available

Get IBXs

Authorizations:

BearerAuth

query Parameters

offset	integer >= 0 Default: 0 Example: offset=0 Pagination offset
limit	integer >= 0 Default: 50 Example: limit=50 Max number of returned results
service.connection.type required	string (ConnectionType) Enum: "IA_C" "IA_VC" Example: service.connection.type=IA_C Service connection type (physical, virtual)
connection.aside.accessPoint.type	string Enum: "COLO" "VD" "PORT" Service connection access point type. When not provided, COLO type is used by default.
asset.type	string Value: "CABINET" Example: asset.type=CABINET Specifies the type of an asset the user must have in the IBX

Responses

Response Schema: application/json

required

object (Pagination)

offset required	integer <int64> >= 0
limit required	integer <int64> >= 0
total required	integer <int64>
next	string Next page link
previous	string Previous page link

required

Array of objects (Ibx)

Array

href required	string
countryCode	string
countryName	string
region	string Enum: "APAC" "EMEA" "AMER"
metroCode	string (MetroCode) ^[A-Z]{2, 2}$
ibxCode	string <^[A-Z]{2, 2}[0-9]+X?$> (IbxCode) IBX data center code
	object (GeoCoordinates)

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2,
"next": "string",
"previous": "string"
},
"data": [{"href": "https://api.equinix.com/internetAccess/ibxs/WA1",
"countryCode": "PL",
"countryName": "Poland",
"region": "EMEA",
"metroCode": "WA",
"ibxCode": "WA1",
"geoCoordinates": {"latitude": 53.55,
"longitude": 9.95
}
}
]
}

EIA Service

Equinix Internet Access Service API

Creates Equinix Internet Access Service

By passing in the appropriate options, you can create Equinix Internet Access Service product. The entire request either succeeds or fails. In case of failure all the changes in the system are rolled back, so the system gets back to its stated before submitting the request

Authorizations:

BearerAuth

Request Body schema: application/json
required

Options for creating Equinix Internet Access Service product

tags

Array of strings

name

string (ServiceName) <= 64 characters

description

string (ServiceDescription) <= 255 characters

type

required

string (ServiceType)

Enum: "SINGLE" "DUAL"

SINGLE - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide DUAL - Internet Access Service supported with two redundant Connections originating from two redundant AccessPoints on the Aside and terminating to two redundant Internet Routers on the ZSide

connections

required

Array of strings <uuid> (ConnectionId) [ 1 .. 2 ] items [ items <uuid > ]

Collection of service connections uuids

required

any (RoutingProtocolRequest)

tags

Array of strings

type

required

string <^(BGP|DIRECT|STATIC)$>

Default: "DIRECT"

Allowed values:

BGP
DIRECT
STATIC

DIRECT

name

string

Name of the routing protocol instance.

description

string

Description of the routing protocol instance

object (DirectRoutingProtocolIpv4Request)

required	Array of objects (CustomerRouteIpv4Request) non-empty Collection of customer routes of IP Version 4 (IPv4)
	Array of objects (DirectPeeringIpv4Request) [ 0 .. 2 ] items

object (DirectRoutingProtocolIpv6Request)

required	Array of objects (CustomerRouteIpv6Request) non-empty Collection of customer routes of IP Version 6 (IPv6)
	Array of objects (DirectPeeringIpv6Request) [ 0 .. 2 ] items

object (ServiceOrder)

Array of objects (ContactItem)

Array

href	string Account URI
type required	string (ContactType) Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING" Contact type
registeredUser	string (UserIdentifier) Identifies (e.g., contactId, userId, userKey) a registered user.
firstName	string
lastName	string
timezone	string
availability	string (ContactAvailability) Enum: "WORK_HOURS" "ANYTIME" "CUSTOMER_BUSINESS_HOURS" "NOT_AVAILABLE"
notes	string Describe any contact preferences
	Array of objects (ContactItemDetails)

object (ServicePurchaseOrder)

type	string (PurchaseOrderType) Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER" Purchase order type
number required	string Purchase order number
amount	number >= 1 Amount
startDate	string <date> Start date in YYYY-MM-DD format
endDate	string <date> End date in YYYY-MM-DD format
description	string <= 4096 characters Purchase order description
	object (ServicePurchaseOrderAttachment)

referenceNumber

string

object (OrderSignature)

signatory required	string Enum: "SELF" "DELEGATE" "SUPPORT"
	object (OrderSignatureDelegate)

Responses

Response Schema: application/json

name

string (ServiceName) <= 64 characters

description

string (ServiceDescription) <= 255 characters

type

required

string (ServiceType)

Enum: "SINGLE" "DUAL"

required

Array of objects (Connection) [ 1 .. 2 ] items

Collection of service connections uuids

Array ([ 1 .. 2 ] items)

uuid

required

string <uuid> (ConnectionId)

required

any (RoutingProtocolReadModel)

tags

Array of strings

href

string <URI>

Routing protocol URI

uuid

string <uuid> (RoutingProtocolId)

Routing protocol identifier

type

required

string <^(BGP|DIRECT|STATIC)$>

Default: "DIRECT"

Allowed values:

BGP
DIRECT
STATIC

DIRECT

name

required

string

Name of the routing protocol instance.

description

string

Description of the routing protocol instance

object (RoutingProtocolIpv4)

required	Array of any (RoutingProtocolCustomerRouteIpv4) non-empty
required	Array of objects (RoutingProtocolPeeringIpv4) >= 0 items

object (RoutingProtocolIpv6)

required	Array of any (RoutingProtocolCustomerRouteIpv6) non-empty
required	Array of objects (RoutingProtocolPeeringIpv6) >= 0 items

object (ChangeLog)

createdBy required	string Account number of the account used for object creation
createdByFullName required	string Full name of the account used for object creation
createdByEmail required	string <email> E-mail of the account used for object creation
createdDateTime required	string <date-time> Date and time of object creation
updatedBy required	string Account number of the account that updated the object last time
updatedByFullName required	string Full name of the account that updated the object last time
updatedByEmail required	string <email> E-mail of the account that updated the object last time
updatedDateTime required	string <date-time> Date and time of the account that updated the object last time
deletedBy	string Account number of the account that updated the object last time
deletedByFullName	string Full name of the account that updated the object last time
deletedByEmail	string <email> E-mail of the account that updated the object last time
deletedDateTime	string <date-time> Date and time of the account that updated the object last time

bandwidth

integer

Service bandwidth in Mbps

object (ProjectReadModel)

href required	string <uri> Project URI
projectId required	string identifier of the project
projectName	string name of the project
parentOrganizationId	string
parentOrganizationName	string Name of the parent organization

object (Account)

href required	string <URI> Account URI
accountNumber required	string Account identifier
accountName	string Name of account
orgId	string Customer organization identifier
organizationName	string Customer organization name

required

any (Change)

Current state of latest service change

uuid

required

string (ChangeId)

Uniquely identifies a change

type

required

string (ChangeType)

Enum: "SERVICE_CREATION" "SERVICE_UPDATE" "SERVICE_DELETION"

status

required

Default: "REQUESTED"

Current outcome of the change flow. Allowed values:

REQUESTED
SUBMITTED_FOR_APPROVAL
APPROVED
REJECTED
COMPLETED
FAILED

REQUESTED

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

required

object

required	object (ChangeDataService)
request required	string

object (ChangeLog)

createdBy required	string Account number of the account used for object creation
createdByFullName required	string Full name of the account used for object creation
createdByEmail required	string <email> E-mail of the account used for object creation
createdDateTime required	string <date-time> Date and time of object creation
updatedBy required	string Account number of the account that updated the object last time
updatedByFullName required	string Full name of the account that updated the object last time
updatedByEmail required	string <email> E-mail of the account that updated the object last time
updatedDateTime required	string <date-time> Date and time of the account that updated the object last time
deletedBy	string Account number of the account that updated the object last time
deletedByFullName	string Full name of the account that updated the object last time
deletedByEmail	string <email> E-mail of the account that updated the object last time
deletedDateTime	string <date-time> Date and time of the account that updated the object last time

object (ServiceOrderReadModel)

Array of objects (ContactItem)

Array

href	string Account URI
type required	string (ContactType) Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING" Contact type
registeredUser	string (UserIdentifier) Identifies (e.g., contactId, userId, userKey) a registered user.
firstName	string
lastName	string
timezone	string
availability	string (ContactAvailability) Enum: "WORK_HOURS" "ANYTIME" "CUSTOMER_BUSINESS_HOURS" "NOT_AVAILABLE"
notes	string Describe any contact preferences
	Array of objects (ContactItemDetails)

object (ServicePurchaseOrder)

type	string (PurchaseOrderType) Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER" Purchase order type
number required	string Purchase order number
amount	number >= 1 Amount
startDate	string <date> Start date in YYYY-MM-DD format
endDate	string <date> End date in YYYY-MM-DD format
description	string <= 4096 characters Purchase order description
	object (ServicePurchaseOrderAttachment)

referenceNumber

string

object (OrderSignature)

signatory required	string Enum: "SELF" "DELEGATE" "SUPPORT"
	object (OrderSignatureDelegate)

href

required

string

Order URI

uuid

required

string <uuid> (ServiceOrderId)

type

required

string (ServiceOrderType)

Enum: "NEW" "AMENDMENT"

status

required

string (ServiceOrderStatus)

Enum: "PROCESSING" "AWAITING_SIGNATURE" "SIGNATURE_REJECTED" "SIGNATURE_EXPIRED" "SUBMITTED" "COMPLETED" "FAILED"

Order status

required

object (ChangeLog)

createdBy required	string Account number of the account used for object creation
createdByFullName required	string Full name of the account used for object creation
createdByEmail required	string <email> E-mail of the account used for object creation
createdDateTime required	string <date-time> Date and time of object creation
updatedBy required	string Account number of the account that updated the object last time
updatedByFullName required	string Full name of the account that updated the object last time
updatedByEmail required	string <email> E-mail of the account that updated the object last time
updatedDateTime required	string <date-time> Date and time of the account that updated the object last time
deletedBy	string Account number of the account that updated the object last time
deletedByFullName	string Full name of the account that updated the object last time
deletedByEmail	string <email> E-mail of the account that updated the object last time
deletedDateTime	string <date-time> Date and time of the account that updated the object last time

number

required

string

Order number

uuid

required

string <uuid> (ServiceId)

Service identifier

state

required

string (ServiceState)

Enum: "PENDING" "PROVISIONING" "ACTIVE" "INACTIVE" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

useCase

required

string (UseCase)

Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

Request samples

Payload

Content type

application/json

{"tags": ["tag1",
"tag2",
"tag3"
],
"name": "string",
"description": "string",
"type": "SINGLE",
"connections": ["9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
],
"routingProtocol": {"tags": ["tag1",
"tag2",
"tag3"
],
"type": "DIRECT",
"name": "WebServers Routes",
"description": "Routes to customer facing web server\n",
"ipv4": {"customerRoutes": [{"ipBlock": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"prefixLength": 24,
"addressingPlans": [{"size": 1,
"purpose": "Provide internet services to the customers\n",
"immediate": 1,
"afterThreeMonths": 1
}
],
"questions": [{"type": "PRIVATE_SPACE_CONSIDERED",
"answer": "YES"
}
]
},
"prefix": "198.51.100.0/24"
}
],
"peerings": [{"connection": {"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
},
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "18.15.15.18"
}
]
},
"ipv6": {"customerRoutes": [{"ipBlock": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"prefixLength": 48
},
"prefix": "2001:db8::/64"
}
],
"peerings": [{"connection": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "1002:0db8:85a3:0000:0000:8a2e:0370:6223"
}
]
}
},
"order": {"contacts": [{"href": "https://api.equinix.com/access/v2/users/john_doe",
"type": "ORDERING",
"registeredUser": "john_doe",
"firstName": "John",
"lastName": "Doe",
"timezone": "Pacific",
"availability": "WORK_HOURS",
"notes": "For urgent cases please make a phone call.",
"details": [{"type": "EMAIL",
"value": "john.doe@nowhere.com",
"notes": "org internal communication only"
}
]
}
],
"purchaseOrder": {"type": "STANDARD_PURCHASE_ORDER",
"number": "129105284100",
"amount": 100.5,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "example purchase order description",
"attachment": {"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}
},
"referenceNumber": "239384723943",
"signature": {"signatory": "SELF",
"delegate": {"firstName": "string",
"lastName": "string",
"email": "cto@business.com"
}
}
}
}

Response samples

Content type

application/json

{"name": "string",
"description": "string",
"type": "SINGLE",
"connections": [{"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"routingProtocol": {"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "DIRECT",
"name": "WebServers Routes",
"description": "Routes to customer facing web servers",
"ipv4": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "198.51.100.0/24",
"prefixLength": 30,
"addressingPlans": [{"size": 1,
"purpose": "Provide internet services to the customers\n",
"immediate": 1,
"afterThreeMonths": 1
}
],
"questions": [{"type": "PRIVATE_SPACE_CONSIDERED",
"answer": "YES"
}
]
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "7.7.7.0/30",
"prefixLength": 30
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"ipv6": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "2001:db8::/64",
"prefixLength": 64
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "2000:3333:0000:0000:0000:0000:0000:0000/64",
"prefixLength": 64
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
}
},
"bandwidth": 1000,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/371",
"projectId": "9713123422221",
"projectName": "US Office",
"parentOrganizationId": "22331",
"parentOrganizationName": "ABC Company"
},
"account": {"href": "https://api.equinix.com/internetAccess/v1/accounts/1234",
"accountNumber": "1234533211",
"accountName": "Company account",
"orgId": "1232",
"organizationName": "Equinix, Inc."
},
"change": {"uuid": "string",
"type": "SERVICE_CREATION",
"status": "REQUESTED",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedDateTime": "2020-11-06T07:00:00Z",
"information": "string",
"data": {"service": {"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b"
},
"request": "string"
}
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"order": {"contacts": [{"href": "https://api.equinix.com/access/v2/users/john_doe",
"type": "ORDERING",
"registeredUser": "john_doe",
"firstName": "John",
"lastName": "Doe",
"timezone": "Pacific",
"availability": "WORK_HOURS",
"notes": "For urgent cases please make a phone call.",
"details": [{"type": "EMAIL",
"value": "john.doe@nowhere.com",
"notes": "org internal communication only"
}
]
}
],
"purchaseOrder": {"type": "STANDARD_PURCHASE_ORDER",
"number": "129105284100",
"amount": 100.5,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "example purchase order description",
"attachment": {"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}
},
"referenceNumber": "239384723943",
"signature": {"signatory": "SELF",
"delegate": {"firstName": "string",
"lastName": "string",
"email": "cto@business.com"
}
},
"href": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"type": "NEW",
"status": "COMPLETED",
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"number": "1-9234239473"
},
"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b",
"state": "PENDING",
"useCase": "MAIN"
}

Get Equinix Internet Access Service details

Get Equinix Internet Access Service details. ^Beta

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid> (ServiceId)

Example: 919ac898-a4b9-4f9d-b684-aa09ddc65b1b

Service identifier

Responses

Response Schema: application/json

tags

Array of strings

href

required

string <uri>

Internet access URI

uuid

required

string <uuid> (ServiceId)

Service identifier

type

required

string (ServiceType)

Enum: "SINGLE" "DUAL"

name

required

string

Name of the service This name should only contain spaces, the characters "_", "-", letters or numbers. The name cannot start or end with a "-". This name can have only maximum of 24 characters

description

string

Description of the service

bandwidth

required

integer <int64> >= 1000

Bandwidth of the service in Mbps

billing

required

string (ServiceBilling)

Enum: "FIXED" "USAGE_BASED" "BURST_BASED"

Billing type of service

state

required

string (ServiceState)

Enum: "PENDING" "PROVISIONING" "ACTIVE" "INACTIVE" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

required

any (Change)

Current state of latest service change

uuid

required

string (ChangeId)

Uniquely identifies a change

type

required

string (ChangeType)

Enum: "SERVICE_CREATION" "SERVICE_UPDATE" "SERVICE_DELETION"

status

required

Default: "REQUESTED"

Current outcome of the change flow. Allowed values:

REQUESTED
SUBMITTED_FOR_APPROVAL
APPROVED
REJECTED
COMPLETED
FAILED

REQUESTED

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

required

object

required	object (ChangeDataService)
request required	string

required

object (ChangeLog)

createdBy required	string Account number of the account used for object creation
createdByFullName required	string Full name of the account used for object creation
createdByEmail required	string <email> E-mail of the account used for object creation
createdDateTime required	string <date-time> Date and time of object creation
updatedBy required	string Account number of the account that updated the object last time
updatedByFullName required	string Full name of the account that updated the object last time
updatedByEmail required	string <email> E-mail of the account that updated the object last time
updatedDateTime required	string <date-time> Date and time of the account that updated the object last time
deletedBy	string Account number of the account that updated the object last time
deletedByFullName	string Full name of the account that updated the object last time
deletedByEmail	string <email> E-mail of the account that updated the object last time
deletedDateTime	string <date-time> Date and time of the account that updated the object last time

required

Array of objects (ConnectionReadModel) non-empty

Array (non-empty)

uuid required	string <uuid> (ConnectionId)
href required	string <URI> (ConnectionHref) Connection URI
type	string (ConnectionType) Enum: "IA_C" "IA_VC"
required	object (ASide)

required

any (RoutingProtocolReadModel)

tags

Array of strings

href

string <URI>

Routing protocol URI

uuid

string <uuid> (RoutingProtocolId)

Routing protocol identifier

type

required

string <^(BGP|DIRECT|STATIC)$>

Default: "DIRECT"

Allowed values:

BGP
DIRECT
STATIC

DIRECT

name

required

string

Name of the routing protocol instance.

description

string

Description of the routing protocol instance

object (RoutingProtocolIpv4)

required	Array of any (RoutingProtocolCustomerRouteIpv4) non-empty
required	Array of objects (RoutingProtocolPeeringIpv4) >= 0 items

object (RoutingProtocolIpv6)

required	Array of any (RoutingProtocolCustomerRouteIpv6) non-empty
required	Array of objects (RoutingProtocolPeeringIpv6) >= 0 items

object (ChangeLog)

createdBy required	string Account number of the account used for object creation
createdByFullName required	string Full name of the account used for object creation
createdByEmail required	string <email> E-mail of the account used for object creation
createdDateTime required	string <date-time> Date and time of object creation
updatedBy required	string Account number of the account that updated the object last time
updatedByFullName required	string Full name of the account that updated the object last time
updatedByEmail required	string <email> E-mail of the account that updated the object last time
updatedDateTime required	string <date-time> Date and time of the account that updated the object last time
deletedBy	string Account number of the account that updated the object last time
deletedByFullName	string Full name of the account that updated the object last time
deletedByEmail	string <email> E-mail of the account that updated the object last time
deletedDateTime	string <date-time> Date and time of the account that updated the object last time

required

Array of objects (Location) non-empty

Array (non-empty)

metroCode required	string (MetroCode) ^[A-Z]{2, 2}$
ibxCode required	string <^[A-Z]{2, 2}[0-9]+X?$> (IbxCode) IBX data center code

required

object (Account)

href required	string <URI> Account URI
accountNumber required	string Account identifier
accountName	string Name of account
orgId	string Customer organization identifier
organizationName	string Customer organization name

required

object (ProjectReadModel)

href required	string <uri> Project URI
projectId required	string identifier of the project
projectName	string name of the project
parentOrganizationId	string
parentOrganizationName	string Name of the parent organization

required

object (ServiceOrderReadModel)

Array of objects (ContactItem)

Array

href	string Account URI
type required	string (ContactType) Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING" Contact type
registeredUser	string (UserIdentifier) Identifies (e.g., contactId, userId, userKey) a registered user.
firstName	string
lastName	string
timezone	string
availability	string (ContactAvailability) Enum: "WORK_HOURS" "ANYTIME" "CUSTOMER_BUSINESS_HOURS" "NOT_AVAILABLE"
notes	string Describe any contact preferences
	Array of objects (ContactItemDetails)

object (ServicePurchaseOrder)

type	string (PurchaseOrderType) Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER" Purchase order type
number required	string Purchase order number
amount	number >= 1 Amount
startDate	string <date> Start date in YYYY-MM-DD format
endDate	string <date> End date in YYYY-MM-DD format
description	string <= 4096 characters Purchase order description
	object (ServicePurchaseOrderAttachment)

referenceNumber

string

object (OrderSignature)

signatory required	string Enum: "SELF" "DELEGATE" "SUPPORT"
	object (OrderSignatureDelegate)

href

required

string

Order URI

uuid

required

string <uuid> (ServiceOrderId)

type

required

string (ServiceOrderType)

Enum: "NEW" "AMENDMENT"

status

required

string (ServiceOrderStatus)

Enum: "PROCESSING" "AWAITING_SIGNATURE" "SIGNATURE_REJECTED" "SIGNATURE_EXPIRED" "SUBMITTED" "COMPLETED" "FAILED"

Order status

required

object (ChangeLog)

createdBy required	string Account number of the account used for object creation
createdByFullName required	string Full name of the account used for object creation
createdByEmail required	string <email> E-mail of the account used for object creation
createdDateTime required	string <date-time> Date and time of object creation
updatedBy required	string Account number of the account that updated the object last time
updatedByFullName required	string Full name of the account that updated the object last time
updatedByEmail required	string <email> E-mail of the account that updated the object last time
updatedDateTime required	string <date-time> Date and time of the account that updated the object last time
deletedBy	string Account number of the account that updated the object last time
deletedByFullName	string Full name of the account that updated the object last time
deletedByEmail	string <email> E-mail of the account that updated the object last time
deletedDateTime	string <date-time> Date and time of the account that updated the object last time

number

required

string

Order number

useCase

required

string (UseCase)

Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

Response samples

Content type

application/json

{"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec",
"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b",
"type": "SINGLE",
"name": "Internet Access",
"description": "Internet access service",
"bandwidth": 1000,
"billing": "FIXED",
"state": "PENDING",
"change": {"uuid": "string",
"type": "SERVICE_CREATION",
"status": "REQUESTED",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedDateTime": "2020-11-06T07:00:00Z",
"information": "string",
"data": {"service": {"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b"
},
"request": "string"
}
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"connections": [{"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "IA_C",
"aSide": {"type": "string",
"service": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
}
],
"routingProtocol": {"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "DIRECT",
"name": "WebServers Routes",
"description": "Routes to customer facing web servers",
"ipv4": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "198.51.100.0/24",
"prefixLength": 30,
"addressingPlans": [{"size": 1,
"purpose": "Provide internet services to the customers\n",
"immediate": 1,
"afterThreeMonths": 1
}
],
"questions": [{"type": "PRIVATE_SPACE_CONSIDERED",
"answer": "YES"
}
]
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "7.7.7.0/30",
"prefixLength": 30
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"ipv6": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "2001:db8::/64",
"prefixLength": 64
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "2000:3333:0000:0000:0000:0000:0000:0000/64",
"prefixLength": 64
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
}
},
"locations": [{"metroCode": "WA",
"ibxCode": "WA1"
}
],
"account": {"href": "https://api.equinix.com/internetAccess/v1/accounts/1234",
"accountNumber": "1234533211",
"accountName": "Company account",
"orgId": "1232",
"organizationName": "Equinix, Inc."
},
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/371",
"projectId": "9713123422221",
"projectName": "US Office",
"parentOrganizationId": "22331",
"parentOrganizationName": "ABC Company"
},
"order": {"contacts": [{"href": "https://api.equinix.com/access/v2/users/john_doe",
"type": "ORDERING",
"registeredUser": "john_doe",
"firstName": "John",
"lastName": "Doe",
"timezone": "Pacific",
"availability": "WORK_HOURS",
"notes": "For urgent cases please make a phone call.",
"details": [{"type": "EMAIL",
"value": "john.doe@nowhere.com",
"notes": "org internal communication only"
}
]
}
],
"purchaseOrder": {"type": "STANDARD_PURCHASE_ORDER",
"number": "129105284100",
"amount": 100.5,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "example purchase order description",
"attachment": {"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}
},
"referenceNumber": "239384723943",
"signature": {"signatory": "SELF",
"delegate": {"firstName": "string",
"lastName": "string",
"email": "cto@business.com"
}
},
"href": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"type": "NEW",
"status": "COMPLETED",
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"number": "1-9234239473"
},
"useCase": "MAIN"
}

Deletes Equinix Internet Access Service

Delete Equinix Internet Access product by passing the id of the service. The entire request either succeeds or fails. ^Beta

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid> (ServiceId)

Example: 919ac898-a4b9-4f9d-b684-aa09ddc65b1b

Service identifier

query Parameters

dryRun

boolean

Example: dryRun=true

Setting this parameter to true will perform only request validation without actually deleting the service

Responses

Response samples

Content type

application/json

[{"errorCode": "EQ-7100010",
"errorMessage": "Validation Failure",
"correlationId": "sampleCorrelationId"
}
]

Updates Equinix Internet Access Service

Updates properties of Equinix Internet Access

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid> (ServiceId)

Example: 919ac898-a4b9-4f9d-b684-aa09ddc65b1b

Service identifier

query Parameters

dryRun

boolean

Example: dryRun=true

Setting this parameter to true will perform only request validation without actually updating the service

Request Body schema: application/json
required

Array (= 1 items)

required

string <^(replace)$>

Default: "replace"

path

required

string <^(\/bandwidth)$>

Default: "/bandwidth"

Path inside document leading to updated parameter. Allowed values:

/bandwidth

value

required

integer >= 0

new value for updated parameter

object (ServiceOrder)

	Array of objects (ContactItem)
	object (ServicePurchaseOrder)
referenceNumber	string
	object (OrderSignature)

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/bandwidth",
"value": 0,
"order": {"contacts": [{"href": "https://api.equinix.com/access/v2/users/john_doe",
"type": "ORDERING",
"registeredUser": "john_doe",
"firstName": "John",
"lastName": "Doe",
"timezone": "Pacific",
"availability": "WORK_HOURS",
"notes": "For urgent cases please make a phone call.",
"details": [{"type": "EMAIL",
"value": "john.doe@nowhere.com",
"notes": "org internal communication only"
}
]
}
],
"purchaseOrder": {"type": "STANDARD_PURCHASE_ORDER",
"number": "129105284100",
"amount": 100.5,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "example purchase order description",
"attachment": {"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}
},
"referenceNumber": "239384723943",
"signature": {"signatory": "SELF",
"delegate": {"firstName": "string",
"lastName": "string",
"email": "cto@business.com"
}
}
}
}
]

Response samples

Content type

application/json

{"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec",
"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b",
"type": "SINGLE",
"name": "Internet Access",
"description": "Internet access service",
"bandwidth": 1000,
"billing": "FIXED",
"state": "PENDING",
"change": {"uuid": "string",
"type": "SERVICE_CREATION",
"status": "REQUESTED",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedDateTime": "2020-11-06T07:00:00Z",
"information": "string",
"data": {"service": {"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b"
},
"request": "string"
}
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"connections": [{"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "IA_C",
"aSide": {"type": "string",
"service": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
}
],
"routingProtocol": {"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "DIRECT",
"name": "WebServers Routes",
"description": "Routes to customer facing web servers",
"ipv4": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "198.51.100.0/24",
"prefixLength": 30,
"addressingPlans": [{"size": 1,
"purpose": "Provide internet services to the customers\n",
"immediate": 1,
"afterThreeMonths": 1
}
],
"questions": [{"type": "PRIVATE_SPACE_CONSIDERED",
"answer": "YES"
}
]
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "7.7.7.0/30",
"prefixLength": 30
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"ipv6": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "2001:db8::/64",
"prefixLength": 64
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "2000:3333:0000:0000:0000:0000:0000:0000/64",
"prefixLength": 64
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
}
},
"locations": [{"metroCode": "WA",
"ibxCode": "WA1"
}
],
"account": {"href": "https://api.equinix.com/internetAccess/v1/accounts/1234",
"accountNumber": "1234533211",
"accountName": "Company account",
"orgId": "1232",
"organizationName": "Equinix, Inc."
},
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/371",
"projectId": "9713123422221",
"projectName": "US Office",
"parentOrganizationId": "22331",
"parentOrganizationName": "ABC Company"
},
"order": {"contacts": [{"href": "https://api.equinix.com/access/v2/users/john_doe",
"type": "ORDERING",
"registeredUser": "john_doe",
"firstName": "John",
"lastName": "Doe",
"timezone": "Pacific",
"availability": "WORK_HOURS",
"notes": "For urgent cases please make a phone call.",
"details": [{"type": "EMAIL",
"value": "john.doe@nowhere.com",
"notes": "org internal communication only"
}
]
}
],
"purchaseOrder": {"type": "STANDARD_PURCHASE_ORDER",
"number": "129105284100",
"amount": 100.5,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "example purchase order description",
"attachment": {"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}
},
"referenceNumber": "239384723943",
"signature": {"signatory": "SELF",
"delegate": {"firstName": "string",
"lastName": "string",
"email": "cto@business.com"
}
},
"href": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"type": "NEW",
"status": "COMPLETED",
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"number": "1-9234239473"
},
"useCase": "MAIN"
}

Get Equinix Internet Access Services

Get Equinix Internet Access Services that match specified criteria. ^Beta

Authorizations:

BearerAuth

query Parameters

offset	number Example: offset=20 Search result offset
limit	number Example: limit=35 Search result limit
sort	string^([-]?[\/][a-z]+[,]?)+$ Example: sort=/name,-/type Search result sorting

Request Body schema: application/json

Search filters

object (Filter)

Array of objects (AndQuery)

Array

property required	string
operator required	string Value: "="
values required	Array of strings

Responses

Response Schema: application/json

required

object (Pagination)

offset required	integer <int64> >= 0
limit required	integer <int64> >= 0
total required	integer <int64>
next	string Next page link
previous	string Previous page link

required

Array of objects (Sort)

Array

direction required	string Default: "ASC" Enum: "ASC" "DESC" direction of sorting.
property required	string property used for sorting

required

Array of objects (ServiceReadModel)

Array

tags	Array of strings
href required	string <uri> Internet access URI
uuid required	string <uuid> (ServiceId) Service identifier
type required	string (ServiceType) Enum: "SINGLE" "DUAL" SINGLE - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide DUAL - Internet Access Service supported with two redundant Connections originating from two redundant AccessPoints on the Aside and terminating to two redundant Internet Routers on the ZSide
name required	string Name of the service This name should only contain spaces, the characters "_", "-", letters or numbers. The name cannot start or end with a "-". This name can have only maximum of 24 characters
description	string Description of the service
bandwidth required	integer <int64> >= 1000 Bandwidth of the service in Mbps
billing required	string (ServiceBilling) Enum: "FIXED" "USAGE_BASED" "BURST_BASED" Billing type of service
state required	string (ServiceState) Enum: "PENDING" "PROVISIONING" "ACTIVE" "INACTIVE" "DEPROVISIONING" "DEPROVISIONED" "FAILED"
required	any (Change) Current state of latest service change
required	object (ChangeLog)
required	Array of objects (ConnectionReadModel) non-empty
required	any (RoutingProtocolReadModel)
required	Array of objects (Location) non-empty
required	object (Account)
required	object (ProjectReadModel)
required	object (ServiceOrderReadModel)
useCase required	string (UseCase) Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "string",
"operator": "=",
"values": ["string"
]
}
]
}
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2,
"next": "string",
"previous": "string"
},
"sort": [{"direction": "ASC",
"property": "/name"
}
],
"data": [{"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec",
"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b",
"type": "SINGLE",
"name": "Internet Access",
"description": "Internet access service",
"bandwidth": 1000,
"billing": "FIXED",
"state": "PENDING",
"change": {"uuid": "string",
"type": "SERVICE_CREATION",
"status": "REQUESTED",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedDateTime": "2020-11-06T07:00:00Z",
"information": "string",
"data": {"service": {"uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b"
},
"request": "string"
}
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"connections": [{"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "IA_C",
"aSide": {"type": "string",
"service": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
}
],
"routingProtocol": {"tags": ["tag1",
"tag2",
"tag3"
],
"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81",
"type": "DIRECT",
"name": "WebServers Routes",
"description": "Routes to customer facing web servers",
"ipv4": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "198.51.100.0/24",
"prefixLength": 30,
"addressingPlans": [{"size": null,
"purpose": null,
"immediate": null,
"afterThreeMonths": null
}
],
"questions": [{"type": null,
"answer": null
}
]
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "7.7.7.0/30",
"prefixLength": 30
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"ipv6": {"customerRoutes": [{"importPolicy": "PA",
"ipBlock": {"href": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"uuid": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8",
"type": "IA_IP_BLOCK",
"prefix": "2001:db8::/64",
"prefixLength": 64
}
}
],
"peerings": [{"connections": [{"href": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}
],
"customerPeerIps": ["string"
],
"peerSubnet": {"prefix": "2000:3333:0000:0000:0000:0000:0000:0000/64",
"prefixLength": 64
},
"vrrpEnabled": true,
"equinixPeerIps": ["string"
],
"equinixVRRPIp": "string",
"customerVRRPIp": "string"
}
]
},
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
}
},
"locations": [{"metroCode": "WA",
"ibxCode": "WA1"
}
],
"account": {"href": "https://api.equinix.com/internetAccess/v1/accounts/1234",
"accountNumber": "1234533211",
"accountName": "Company account",
"orgId": "1232",
"organizationName": "Equinix, Inc."
},
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/371",
"projectId": "9713123422221",
"projectName": "US Office",
"parentOrganizationId": "22331",
"parentOrganizationName": "ABC Company"
},
"order": {"contacts": [{"href": "https://api.equinix.com/access/v2/users/john_doe",
"type": "ORDERING",
"registeredUser": "john_doe",
"firstName": "John",
"lastName": "Doe",
"timezone": "Pacific",
"availability": "WORK_HOURS",
"notes": "For urgent cases please make a phone call.",
"details": [{"type": "EMAIL",
"value": "john.doe@nowhere.com",
"notes": "org internal communication only"
}
]
}
],
"purchaseOrder": {"type": "STANDARD_PURCHASE_ORDER",
"number": "129105284100",
"amount": 100.5,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "example purchase order description",
"attachment": {"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb"
}
},
"referenceNumber": "239384723943",
"signature": {"signatory": "SELF",
"delegate": {"firstName": "string",
"lastName": "string",
"email": "cto@business.com"
}
},
"href": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"type": "NEW",
"status": "COMPLETED",
"changeLog": {"createdBy": "1232",
"createdByFullName": "John Doe",
"createdByEmail": "john.doe@company.com",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedBy": "1234",
"updatedByFullName": "Ryan Einstein",
"updatedByEmail": "ryan.einstein@company.com",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedBy": "1234",
"deletedByFullName": "Ryan Einstein",
"deletedByEmail": "ryan.einstein@company.com",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"number": "1-9234239473"
},
"useCase": "MAIN"
}
]
}

Equinix Internet Access API (2.4)

Product Availability

Returns IBXs where EIA is available

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

EIA Service

Creates Equinix Internet Access Service

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Get Equinix Internet Access Service details

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Deletes Equinix Internet Access Service

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Updates Equinix Internet Access Service

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Equinix Internet Access Services

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required