Skip to main content
API docs by Redocly

Equinix Internet Access API (1.2.15)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Equinix Internet Access provides direct access to the Internet with scalable bandwidth options in IBX data centers. This current set of API’s allows for ordering of Equinix Internet Access on ports dedicated only to this service. Ordering virtual connections to the internet over an existing Fabric port, shared with other virtual connections, will be added in a future set of API’s. Single or dual port connections are available, ranging from 1G to 100G. Multiple large Internet Service Providers (ISPs) are used at every location to ensure redundancy. Equinix Internet Access supports various protocols, including Border Gateway Protocol (BGP), VRRP (static and direct), and Direct and Static routing. Equinix Internet Access routers are connected to local Equinix Internet Exchange (IX) switches and other partner peering platforms offering a shortcut to access local peers. This approach delivers optimal performance.

Find more information on Equinix Developer Portal

Accounts

Customer accounts available for Equinix Internet Access

Lists accounts available for user within IBX

List all accounts that are available for EIA ordering in a given IBX.

Authorizations:
BearerAuth
query Parameters
operationalUnits.ibxs.ibx
required
string^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$
Example: operationalUnits.ibxs.ibx=SG1

Operational Unit IBX code

project.projectId
string
Example: project.projectId=7348

Customer Resource Hierarchy Project identifier, for future use, not applicable in EIA on dedicated port scenario

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (AccountDetails)
Array
accountNumber
required
string
accountName
required
string
required
object (Account_billing)
required
Array of objects (AccountOperationalUnit)
orgId
string

Customer organization identifier

organizationName
string

Customer organization name

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Returns a single account

Account object for given account number.

Authorizations:
BearerAuth
path Parameters
accountNumber
required
string^\d+$
Example: 100013200

Number of account to search by

Responses

Response Schema: application/json
accountNumber
required
string
accountName
required
string
required
object (Account_billing)
signatureRequired
required
boolean

Whether the signature is required

poExempted
required
boolean

Whether the purchase order has been exempted

poBearing
required
boolean

Whether the purchase order is required

currency
required
string (CurrencyCode)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

Currency codes

required
Array of objects (AccountOperationalUnit)
Array
required
Array of objects (OperationalUnit_ibxs)
Array of objects (OperationalUnit_metros)
orgId
string

Customer organization identifier

organizationName
string

Customer organization name

Response samples

Content type
application/json
{
  • "accountNumber": "100013200",
  • "accountName": "Web Henderson",
  • "billing": {
    },
  • "operationalUnits": [
    ],
  • "orgId": "1232",
  • "organizationName": "Equinix, Inc."
}

Lists account agreement statuses

Account agreements for given account number.

Authorizations:
BearerAuth
path Parameters
accountNumber
required
string^\d+$
Example: 100013200

Number of account to search by

query Parameters
ibx
required
string^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$
Example: ibx=WA1

Agreement IBX

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (AccountAgreements_data)
Array
ibx
string
type
string
Value: "MCA_GTC"

MCA - Master Country Agreement, GTC - Global Terms & Conditions

valid
boolean

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Terms and Conditions

View Equinix terms and conditions

Retrieve terms and conditions

Returns Terms And Conditions as HTML text

Authorizations:
BearerAuth
query Parameters
account.accountNumber
required
string
Example: account.accountNumber=123111232

Account number

location.ibx
required
string
Example: location.ibx=CH2

IBX code for given location

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

connectivitySource.type
required
string
Value: "COLO"
Example: connectivitySource.type=COLO

Connectivity source type

product
required
string
Enum: "IA_C" "IA_VC" "MC_C"
Example: product=IA_C

Product

type
string
Enum: "TERMS_AND_CONDITIONS" "RENEWAL_TERMS" "PRICE_INCREASE_TERMS"
Example: type=TERMS_AND_CONDITIONS

Agreement type

language
string = 2 characters
Default: "en"
Example: language=en

2 letter ISO 639-1 language code

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 (TermsAndConditions)
Array
text
required
string
version
required
string
required
object (TermsAndConditions_location)
required
object (TermsAndConditions_account)
required
object (TermsAndConditions_connectivitySource)
type
required
string
Default: "TERMS_AND_CONDITIONS"
Enum: "TERMS_AND_CONDITIONS" "RENEWAL_TERMS" "PRICE_INCREASE_TERMS"
product
required
string
Enum: "IA_C" "IA_VC" "MC_C"
language
required
string

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Operational Units

View Operational Units

List operational units

Returns list of operational units as JSON object list

Authorizations:
BearerAuth
query Parameters
location.ibx
required
string^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$
Example: location.ibx=SG1

Operational Unit IBX code

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (OperationalUnit)
Array
name
required
string
required
object (Address)
required
object (OperationalUnit_location)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Signature Policies

List signature policies

List signature policies

Returns list of signature policies as JSON object list

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

location.countryCode
string
Example: location.countryCode=US

Country code

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 (SignaturePolicy)
Array
required
object (Signature)
clickThroughAllowed
required
boolean
required
object (SignaturePolicyLocation)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Prices

Search Equinix Internet prices by search criteria

Search EIA prices

Search Equinix Internet Access prices by criteria. Currency depends on the billing account. Internally prices are processed according to ISO 4217 standard. Prices are returned as numbers. If for any reason a product or its part is provided for free, then it will be listed in the response with a price of 0.

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

Request Body schema: application/json
required
required
object (SearchFilter)
required
Array of objects (AndOperator)
Array
property
required
string
operator
required
string
Value: "="
values
required
Array of strings non-empty

Responses

Response Schema: application/json
required
Array of objects (Price)
Array
href
required
string <url>

An absolute URL that returns specified pricing data

type
required
string (ProductType)
Enum: "INTERNET_ACCESS_PRODUCT" "IP_BLOCK_PRODUCT"

Product type

code
required
string

Equinix-assigned product code

name
required
string

Full product name

description
string

Product description

object (CustomerAccount)

Customer billing account data. It must be validated to ensure that (1) it can be used for ordering in the source metro and (2) the user is permitted to access the data.

currency
required
string (CurrencyCode)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

Currency codes

category
required
string (PriceCategory)
Enum: "COUNTRY" "CUSTOMER"

Price category

required
Array of objects (ProductPriceCharge)
required
object (PriceSummary)
object (ServicePrice)

Properties of this object can be used in search in form of JsonPointers unless speficied otherwise.

object (IpBlockProductPrice)

Configuration of the IP block to which the specified connections belong. An IP block is a set of sequential internet protocol (IP) addresses issued to a single entity, such as an internet service provider (ISP). Properties of this object can be used in search in form of JsonPointers, one of ipv4 or ipv6 is required.

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

Request samples

Content type
application/json
Example
{
  • "filter": {
    }
}

Response samples

Content type
application/json
Example
{
  • "pagination": {
    },
  • "data": [
    ]
}

Product Availability

IBXs where Equinix Internet Access is available

Returns requested IBX where EIA is available

Get IBX

Authorizations:
BearerAuth
path Parameters
ibx
required
string
Example: WA1

Ibx code

query Parameters
service.connection.type
string
Enum: "IA_C" "IA_VC"

Service connection type (physical, virtual)

connection.aside.accessPoint.type
string
Enum: "COLO" "VD"

Service connection access point type. When not provided, COLO type is used by default.

Responses

Response Schema: application/json
href
required
string
countryCode
string
countryName
string
region
string
Enum: "APAC" "EMEA" "AMER"
metroCode
string
metroName
string
ibx
string

IBX data center code

object (GeoCoordinates)
latitude
required
number
longitude
required
number

Response samples

Content type
application/json
{}

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
Enum: "IA_C" "IA_VC"
Example: service.connection.type=IA_C

Service connection type (physical, virtual)

connection.aside.accessPoint.type
string
Enum: "COLO" "VD"

Service connection access point type. When not provided, COLO type is used by default.

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
metroName
string
ibx
string

IBX data center code

object (GeoCoordinates)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": []
}

Attribute Eligibility

Allowed Equinix Internet Access configuration values

Routing Protocol Attribute Eligibility API Endpoint

Get routing protocol configurations

Authorizations:
BearerAuth
query Parameters
useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
Example: useCase=MAIN

Use case

type
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
Example: type=SINGLE_PORT

Port type

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (RoutingProtocolConfiguration)
Array
useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
type
required
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
required
object (RoutingProtocolConfiguration_routingProtocol)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Dedicated Bandwidth Attribute Eligibility API Endpoint

Get dedicated bandwidth configurations

Authorizations:
BearerAuth
query Parameters
connection.aside.accessPoint.port.physicalPort.speed
integer

ASide access point physical port speed (Mbps), i.e. 1000, 10000, 100000

billing
string
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
Example: billing=BURST_BASED

Billing type

useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
Example: useCase=MAIN

Use case

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (DedicatedBandwidthConfiguration)
Array
useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
bandwidth
required
integer

in Mbps

minBandwidthCommit
integer

in Mbps

billing
string
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
required
object (DedicatedBandwidthConfiguration_connection)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Virtual Bandwidth Attribute Eligibility API Endpoint

Get virtual bandwidth configurations

Authorizations:
BearerAuth
query Parameters
useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
Example: useCase=MAIN

Use case

billing
string
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
Example: billing=BURST_BASED

Billing type

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (VirtualBandwidthConfiguration)
Array
useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
billing
required
string
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
bandwidth
required
integer

in Mbps

minBandwidthCommit
integer

in Mbps

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Virtual Connection Default Configuration Attribute Eligibility API Endpoint

Get virtual connection default configurations

Authorizations:
BearerAuth
query Parameters
connection.aside.accessPoint.location.metroCode
string

Access point Metro code

connection.aside.accessPoint.location.ibx
required
string^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$
Example: connection.aside.accessPoint.location.ibx=WA1

Access point IBX code

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (VirtualConnectionDefaultConfiguration)
Array
type
required
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
useCase
required
string (ProductCatalogUseCase)
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
billing
required
string (ProductCatalogBillingType)
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
bandwidth
required
integer

in Mbps

minBandwidthCommit
integer

in Mbps

required
object (VirtualConnectionDefaultConfiguration_connection)
required
object (VirtualConnectionDefaultConfiguration_routingProtocol)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Customer Route Configuration API Endpoint

Get customer route configurations

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

useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
Example: useCase=MAIN

Use case

type
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
Example: type=SINGLE_PORT

Type of Equinix Internet Access Service

routingProtocol.type
string
Enum: "BGP" "DIRECT" "STATIC"
Example: routingProtocol.type=BGP

Type of Routing Protocol

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 (CustomerRouteConfiguration)
Array
type
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
useCase
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
object (CustomerRouteConfiguration_routingProtocol)

One of properties ipv4 and ipv6 will be always present in routing protocol object.

Response samples

Content type
application/json
Example
{
  • "pagination": {
    },
  • "data": [
    ]
}

Dedicated port default configurations API Endpoint

Get dedicated port default configurations

Authorizations:
BearerAuth
query Parameters
connection.aside.accessPoint.location.ibx
required
string
Example: connection.aside.accessPoint.location.ibx=WA1

ASide access point location IBX

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (DedicatedPortDefaultConfiguration)
Array
type
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
useCase
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
billing
required
string
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
bandwidth
integer

in Mbps

minBandwidthCommit
integer

in Mbps

required
object (DedicatedPortDefaultConfiguration_connection)
object (DedicatedPortDefaultConfiguration_routingProtocol)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Dedicated Port Attribute Eligibility API Endpoint

Get port configurations

Authorizations:
BearerAuth
query Parameters
connection.aside.accessPoint.port.location.ibx
required
string^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$
Example: connection.aside.accessPoint.port.location.ibx=WA1

ASide access point port location IBX

useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
Example: useCase=MAIN

Use case

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (PortConfiguration)
Array
useCase
required
string
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"
type
required
string (ProductCatalogRedundancy)
Enum: "SINGLE_PORT" "DUAL_PORT"
required
object (PortConfiguration_routingProtocol)
required
object (PortConfiguration_connection)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Purchase Orders

Manage your purchase orders

List purchase orders

List purchase orders

Authorizations:
BearerAuth
path Parameters
accountNumber
required
string
Example: 100013200

Number of account to search by

query Parameters
locations.ibx
string
Example: locations.ibx=WA1

IBX code

category
string
Default: "INTERCONNECTION"
Enum: "ALL_SERVICES" "INTERCONNECTION" "SMART_HANDS" "POWER" "NETWORK" "SERVICES" "SPACE"

product category

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (PurchaseOrder)
Array
type
required
string (PurchaseOrderType)
Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER"

Purchase order type

number
required
string

Purchase order number

required
object (PurchaseOrderAccount)
categories
required
Array of strings
Items Enum: "ALL_SERVICES" "INTERCONNECTION" "NETWORK" "POWER" "SPACE" "SMART_HANDS" "SERVICES"
required
Array of objects (PurchaseOrder_locations)
amount
required
number <double>

Amount

startDate
string <date>

Start date in YYYY-MM-DD format

endDate
string <date>

End date in YYYY-MM-DD format

description
string

Purchase order description

draft
required
boolean <boolean>

Is draft

status
string (PurchaseOrderStatus)
Enum: "DRAFT" "ACTIVE"
currency
required
string (CurrencyCode)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

Currency codes

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Get specified purchase order

Returns single purchase order

Authorizations:
BearerAuth
path Parameters
accountNumber
required
string
Example: 100013200

Number of account to search by

number
required
string
Example: PO-1234567

purchase order number

Responses

Response Schema: application/json
type
required
string (PurchaseOrderType)
Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER"

Purchase order type

number
required
string

Purchase order number

required
object (PurchaseOrderAccount)
accountNumber
string <= 50 characters ^[0-9]+$

Customer billing account number

categories
required
Array of strings
Items Enum: "ALL_SERVICES" "INTERCONNECTION" "NETWORK" "POWER" "SPACE" "SMART_HANDS" "SERVICES"
required
Array of objects (PurchaseOrder_locations)
Array
ibx
required
string
amount
required
number <double>

Amount

startDate
string <date>

Start date in YYYY-MM-DD format

endDate
string <date>

End date in YYYY-MM-DD format

description
string

Purchase order description

draft
required
boolean <boolean>

Is draft

status
string (PurchaseOrderStatus)
Enum: "DRAFT" "ACTIVE"
currency
required
string (CurrencyCode)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

Currency codes

Response samples

Content type
application/json
{
  • "type": "STANDARD_PURCHASE_ORDER",
  • "number": "10010",
  • "account": {
    },
  • "categories": [
    ],
  • "locations": [
    ],
  • "amount": 10000.5,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "description": "Purchase order desc",
  • "draft": false,
  • "status": "DRAFT",
  • "currency": "USD"
}

Cages

List cages available for Equinix Internet Access

Get list of available Cages

Only Cages available for EIA should be returned

Authorizations:
BearerAuth
query Parameters
location.ibx
required
string
Example: location.ibx=CH2

IBX code for given location

account.accountNumber
required
string
Example: account.accountNumber=123111232

Account number

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer [ 0 .. 250 ]
Default: 50
Example: limit=50

Max number of returned results

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 (Cage)
Array
spaceId
required
string
number
required
string
cabinetsCount
required
integer
required
object (Location)
required
object (SecureCageAccount)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Cabinets

List cabinets available for Equinix Internet Access

Get list of available Cabinets

Only Cabinets available for EIA should be returned

Authorizations:
BearerAuth
query Parameters
cage.spaceId
string
Example: cage.spaceId=CH2:03:00603

Cage space ID

location.ibx
string
Example: location.ibx=CH2

IBX code for given location

account.accountNumber
string
Example: account.accountNumber=123111232

Account number

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer [ 0 .. 250 ]
Default: 50
Example: limit=50

Max number of returned results

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 (Cabinet)
Array
spaceId
required
string
number
required
string
patchPanelsCount
required
integer
required
object (CageRef)
required
object (Location)
required
object (SecureCageAccount)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Patch Panels

List patch panels available for Equinix Internet Access

Get list of available Patch Panels

Only Cages available for EIA should be returned

Authorizations:
BearerAuth
query Parameters
location.ibx
required
string
Example: location.ibx=CH2

IBX code for given location

account.accountNumber
required
string
Example: account.accountNumber=123111232

Account number

cage.spaceId
required
string
Example: cage.spaceId=CH2:03:00603

Cage space ID

cabinet.spaceId
required
string
Example: cabinet.spaceId=CH1:01:011201:0204

Cabinet space ID

mediaTypes.name
string
Example: mediaTypes.name=SINGLE_MODE_FIBER

Media Type

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer [ 0 .. 250 ]
Default: 50
Example: limit=50

Max number of returned results

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 (PatchPanel)
Array
number
required
string
customerRefNumber
string
type
required
string
Enum: "EQUINIX_PROVIDED" "CUSTOMER_PROVIDED" "PREWIRE_PANEL_INFRASTRUCTURE" "EQUINIX_INFRASTRUCTURE"
prewired
required
boolean
availablePortsCount
integer
availablePorts
required
Array of integers
ownedPortsCount
integer
required
Array of objects (PatchPanel_ownedPorts)
mediaTypes
required
Array of strings
dedicatedMediaType
required
string
required
object (CageRef)
required
object (CabinetRef)
required
object (Location)
required
object (SecureCageAccount)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Connection Services

List connection services available for Equinix Internet Access

Get list of available connection services

Only Connection Services available for EIA should be returned

Authorizations:
BearerAuth
query Parameters
mediaTypes.connectorTypes.locations.ibx
required
string
Example: mediaTypes.connectorTypes.locations.ibx=SG1

IBX Code

offset
integer >= 0
Default: 0
Example: offset=0

Pagination offset

limit
integer >= 0
Default: 50
Example: limit=50

Max number of returned results

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 (ConnectionService)
Array
name
required
string
Array of objects (MediaType)

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

EIA Order

Equinix Internet Access Order API

Returns EIA Order details

Returns Order details

Authorizations:
BearerAuth
path Parameters
orderUUID
required
string <uuid>
Example: d27c0f84-f1da-498e-95c0-f3d3ae02d16d

UUID of the checked order

Responses

Response Schema: application/json
href
required
string
uuid
required
string <uuid>
type
string (OrderType)
Enum: "NEW" "AMENDMENT"
Array of objects (Contact)
Array
href
required
string
type
required
string (ContactType)
Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING"
registeredUser
required
string

Identifies (e.g., userName) a registered user. If a registered user is specified, then firstName/lastName need not be provided

draft
boolean
Default: false
Array of objects (Link)
Array
href
required
string
rel
string

self, info, update, delete, statistics, events

method
string
authenticate
boolean
Default: false
contentType
string
object (OrderPurchaseOrder)
href
required
string
number
required
string
type
string
Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER"
referenceNumber
string
object (OrderSignature)
signatory
required
string
Enum: "SELF" "DELEGATE" "SUPPORT"
object (OrderSignatureDelegate)
firstName
string
lastName
string
email
required
string <email>

Email address that the signature request should be sent to in case of DELEGATE signature

state
string (OrderState)
Enum: "DRAFT" "PROCESSING" "AWAITING_SIGNATURE" "SIGNATURE_REJECTED" "SIGNATURE_EXPIRED" "COMPLETED" "FAILED"
object (OrderChangeLog)
createdBy
required
string
createdByFullName
required
string
createdByEmail
required
string <email>
createdDateTime
required
string <date-time>
updatedBy
required
string
updatedByFullName
required
string
updatedByEmail
required
string <email>
updatedDateTime
required
string <date-time>
deletedBy
string
deletedByFullName
string
deletedByEmail
string <email>
deletedDateTime
string <date-time>
tags
Array of strings
number
required
string

Response samples

Content type
application/json
{
  • "href": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "AMENDMENT",
  • "contacts": [
    ],
  • "draft": false,
  • "links": [
    ],
  • "purchaseOrder": {
    },
  • "referenceNumber": "239384723943",
  • "signature": {
    },
  • "state": "DRAFT",
  • "changeLog": {
    },
  • "tags": [
    ],
  • "number": "string"
}

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
type
required
string (ServiceType)
Enum: "SINGLE_PORT" "DUAL_PORT"

SINGLE_PORT - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide DUAL_PORT - 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

useCase
required
string (UseCaseType)
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

Service use case

name
required
string

Name of the service instance

description
string

Description of the service instance

bandwidth
required
integer

Service bandwidth in Mbps

minBandwidthCommit
integer >= 0

Service min bandwidth commit in Mbps

billing
string (BillingType)
Default: "FIXED"
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"

Type of billing

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

Collection of service connections

Array ([ 1 .. 2 ] items)
tags
Array of strings
type
required
string (ConnectionType)
Enum: "IA_C" "IA_VC"

Connection type. IA_C - internet access connection on dedicated port; IA_VC - internet access virtual connection on Fabric Port, Virtual Device, Bare Metal, etc.

name
string

Connection name

description
string

Connection name

required
object (ConnectionASide)
draft
boolean
Default: false
required
Array of objects (RoutingProtocolRequest) = 1 items

Collection of routing protocols

Array (= 1 items)
tags
Array of strings
type
required
string (RoutingProtocolType)
name
string

Name of the routing protocol instance.

description
string

Description of the routing protocol instance

object (DirectRoutingProtocolIpv4Request)
object (DirectRoutingProtocolIpv6Request)
object (ServiceOrderRequest)
tags
Array of strings
Array of objects (ServiceOrderContact)
Array
type
required
string (ContactType)
Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING"
firstName
string
lastName
string
timezone
string
notes
string
availability
string
Enum: "WORK_HOURS" "ANYTIME" "CUSTOMER_BUSINESS_HOURS" "NOT_AVAILABLE"
Array of objects (ContactRequest_details)
registeredUser
string

Identifies (e.g., userName) a registered user. If a registered user is specified, then firstName/lastName need not be provided

draft
boolean
Default: false
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 (OrderSignatureRequest)
signatory
required
string
Enum: "SELF" "DELEGATE" "SUPPORT"
object (OrderSignatureDelegateRequest)
required
object (CustomerBillingAccount)
accountNumber
required
string

Billing account number

object (Project)
projectId
required
string

Customer Resource Hierarchy Project identifier

Responses

Response Schema: application/json
tags
Array of strings
type
required
string (ServiceType)
Enum: "SINGLE_PORT" "DUAL_PORT"

SINGLE_PORT - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide DUAL_PORT - 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

useCase
required
string (UseCaseType)
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

Service use case

name
required
string

Name of the service instance

description
string

Description of the service instance

bandwidth
required
integer

Service bandwidth in Mbps

minBandwidthCommit
integer >= 0

Service min bandwidth commit in Mbps

uuid
required
string <uuid>
object (CustomerAccountReference)
accountNumber
required
string

Billing account number

billing
required
string (BillingType)
Default: "FIXED"
Enum: "FIXED" "USAGE_BASED" "BURST_BASED"

Type of billing

object (ServiceChangeLog)
createdBy
required
string
createdByFullName
required
string
createdByEmail
required
string <email>
createdDateTime
required
string <date-time>
updatedBy
required
string
updatedByFullName
required
string
updatedByEmail
required
string <email>
updatedDateTime
required
string <date-time>
deletedBy
string
deletedByFullName
string
deletedByEmail
string <email>
deletedDateTime
string <date-time>
draft
required
boolean
Default: false
Array of objects (Link)
Array
href
required
string
rel
string

self, info, update, delete, statistics, events

method
string
authenticate
boolean
Default: false
contentType
string
object (ServiceOrderReference)
href
required
string
uuid
required
string <uuid>
type
required
string (ServiceOrderType)
Enum: "NEW" "AMENDMENT"
object (ProjectReference)
href
required
string
projectId
required
string

Customer Resource Hierarchy Project identifier

state
required
string (ServiceState)
Enum: "DRAFT" "PENDING" "PROVISIONING" "ACTIVE" "INACTIVE" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "type": "SINGLE_PORT",
  • "useCase": "MAIN",
  • "name": "WebServers",
  • "description": "Customer facing web servers\n",
  • "bandwidth": 10000,
  • "minBandwidthCommit": 500,
  • "billing": "FIXED",
  • "connections": [
    ],
  • "draft": false,
  • "routingProtocols": [
    ],
  • "order": {
    },
  • "account": {
    },
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "type": "SINGLE_PORT",
  • "useCase": "MAIN",
  • "name": "WebServers",
  • "description": "Customer facing web servers\n",
  • "bandwidth": 10000,
  • "minBandwidthCommit": 500,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": {
    },
  • "billing": "FIXED",
  • "changeLog": {
    },
  • "draft": false,
  • "links": [
    ],
  • "order": {
    },
  • "project": {
    },
  • "state": "DRAFT"
}

Deletes Equinix Internet Access Service

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

Authorizations:
BearerAuth
path Parameters
serviceId
required
string <uuid>
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
{
  • "tags": [
    ],
  • "type": "SINGLE_PORT",
  • "useCase": "MAIN",
  • "name": "WebServers",
  • "description": "Customer facing web servers\n",
  • "bandwidth": 10000,
  • "minBandwidthCommit": 500,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": {
    },
  • "billing": "FIXED",
  • "changeLog": {
    },
  • "draft": false,
  • "links": [
    ],
  • "order": {
    },
  • "project": {
    },
  • "state": "DRAFT"
}

Get Equinix Internet Access Services

Get Equinix Internet Access Services that match specified criteria.

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
href
required
string <uri>

Internet access URI

uuid
required
string <uuid>

Equinix-assigned internet access identifier

type
required
string (ServiceType)
Enum: "SINGLE_PORT" "DUAL_PORT"

SINGLE_PORT - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide DUAL_PORT - 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: "DRAFT" "PENDING" "PROVISIONING" "ACTIVE" "INACTIVE" "DEPROVISIONING" "DEPROVISIONED" "FAILED"
draft
required
boolean

Describes if the service is a draft

useCase
required
string (ServiceUseCase)
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

use case of the service

object (Change)
required
object (ChangeLog)
required
Array of objects (ConnectionReadModel) non-empty
required
Array of objects (RoutingProtocolReadModel) non-empty
required
object (Account)
required
object (ProjectReadModel)
object (OrderReadModel)
tags
Array of strings
required
Array of objects (Link)

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "sort": [
    ],
  • "data": [
    ]
}

Get Equinix Internet Access Service details

Get Equinix Internet Access Service details.

Authorizations:
BearerAuth
path Parameters
serviceUuid
required
string <uuid>
Example: 919ac898-a4b9-4f9d-b684-aa09ddc65b1b

Service identifier

Responses

Response Schema: application/json
href
required
string <uri>

Internet access URI

uuid
required
string <uuid>

Equinix-assigned internet access identifier

type
required
string (ServiceType)
Enum: "SINGLE_PORT" "DUAL_PORT"

SINGLE_PORT - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide DUAL_PORT - 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: "DRAFT" "PENDING" "PROVISIONING" "ACTIVE" "INACTIVE" "DEPROVISIONING" "DEPROVISIONED" "FAILED"
draft
required
boolean

Describes if the service is a draft

useCase
required
string (ServiceUseCase)
Enum: "MAIN" "BACKUP" "MANAGEMENT_ACCESS"

use case of the service

required
object (Change)
href
required
string
uuid
required
string <uuid>
type
required
string (ChangeType)
Enum: "SERVICE_CREATION" "SERVICE_UPDATE" "SERVICE_DELETION"

Change Type

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)
Array
href
string <URI> (ConnectionHref)

Connection URI

uuid
string <uuid> (ConnectionUuid)
type
required
string (ConnectionType)
Enum: "IA_C" "IA_VC"

Connection type. IA_C - internet access connection on dedicated port; IA_VC - internet access virtual connection on Fabric Port, Virtual Device, Bare Metal, etc.

name
required
string

Name of the connection

description
string

Description of the connection

required
object (ChangeLog)
bandwidth
required
integer <int64> >= 1000

Bandwidth of the Connection in Mbps

object (Redundancy)
required
object (ASide)
tags
Array of strings
required
Array of objects (Link)
required
Array of objects (RoutingProtocolReadModel)
Array
href
string <URI>

Routing protocol URI

uuid
string <uuid>

Routing protocol identifier

type
required
string (RoutingProtocolType)
name
required
string

Name of the routing protocol instance.

description
string

Description of the routing protocol instance

object (RoutingProtocolIpv4)
object (RoutingProtocolIpv6)
required
object (ChangeLog)
tags
Array of strings
required
Array of objects (Link)
required
object (Account)
href
required
string <URI>

Account URI

accountNumber
required
string

Account identifier

accountName
required
string

Name of account

orgId
string

Customer organization identifier

organizationName
string

Customer organization name

object (ProjectReadModel)
href
required
string <uri>

Project URI

projectId
required
string

identifier of the project

projectName
required
string

name of the project

parentOrganizationId
required
string
parentOrganizationName
required
string

Name of the parent organization

required
object (OrderReadModel)
href
required
string

Order URI

uuid
required
string <uuid>

Order identifier

type
required
string
Enum: "NEW" "AMENDMENT"

Order type

draft
required
boolean

Describes if the service is a draft

status
required
string
Enum: "DRAFT" "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

object (PurchaseOrderReadModel)
href
required
string

Purchase Order URI

type
required
string
Enum: "STANDARD_PURCHASE_ORDER" "BLANKET_PURCHASE_ORDER"

Order type

number
required
string

Purchase Order number

Array of objects (ContactItem)
Array
href
string

Account URI

type
required
string
Enum: "NOTIFICATION" "TECHNICAL" "ORDERING" "RESELLING" "BILLING"

Contact type

registeredUser
string

Identifies (e.g., contactId, userId, userKey) a registered user.

firstName
string
lastName
string
timezone
string
availability
string
Enum: "WORK_HOURS" "ANYTIME" "CUSTOMER_BUSINESS_HOURS" "NOT_AVAILABLE"
notes
string

Describe any contact preferences

Array of objects (ContactItemDetails)
tags
Array of strings
required
Array of objects (Link)
Array
href
required
string
rel
string

self, info, update, delete, statistics, events

method
string
authenticate
boolean
Default: false
contentType
string
tags
Array of strings
required
Array of objects (Link)
Array
href
required
string
rel
string

self, info, update, delete, statistics, events

method
string
authenticate
boolean
Default: false
contentType
string

Response samples

Content type
application/json
{
  • "href": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec",
  • "uuid": "df043001-bf0a-446b-a48f-bcdcca68a9f3",
  • "type": "SINGLE_PORT",
  • "name": "Internet Access",
  • "description": "Internet access service",
  • "bandwidth": 1000,
  • "billing": "FIXED",
  • "state": "DRAFT",
  • "draft": false,
  • "useCase": "MAIN",
  • "change": {
    },
  • "changeLog": {
    },
  • "connections": [],
  • "routingProtocols": [],
  • "account": {},
  • "project": {},
  • "order": {
    },
  • "tags": [
    ],
  • "links": [
    ]
}