Skip to main content
Loading...

API docs by

Create Internet Access Service

Request

Creates Internet Access Service

Security
BearerAuth
Bodyapplication/jsonrequired
typestring(InternetAccessServiceType)required

Type of the service, either single or dual internet access

Enum:"SINGLE_IA""DUAL_IA"
namestringrequired

The name of the EIA Service

bandwidthinteger

Bandwidth of the service

bandwidthCommitinteger

Minimum bandwidth commit for burst billing variant of the service

routingProtocolobject(InternetAccessRoutingProtocolRequest)required
orderobject(InternetAccessOrderRequest)
billingobjectrequired
projectobject(Project)required
accountobject(InternetAccessAccount)required
Payload
{
  "type": "SINGLE_IA",
  "name": "internet-access-primary",
  "bandwidth": 1000,
  "routingProtocol": {
    "type": "BGP",
    "exportPolicy": "FULL",
    "asn": { … },
    "connections": [ … ],
    "customerRoutes": [ … ]
  },
  "billing": {
    "type": "FIXED"
  },
  "project": {
    "projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
  },
  "account": {
    "accountNumber": "57689234"
  },
  "order": {
    "purchaseOrderNumber": "PO-98765"
  }
}

Responses

EIA Service creation or update accepted

Bodyapplication/json
hrefstring, (uri)required

Service URL path

Example:"https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4"
typestring(InternetAccessServiceType)required

Type of the service, either single or dual internet access

Enum:"SINGLE_IA""DUAL_IA"
uuidstring, (uuid)required

Unique identifier for the EIA Service

namestringrequired

The name of the EIA Service

bandwidthinteger

Bandwidth of the service

bandwidthCommitinteger

Minimum bandwidth commit for burst billing variant of the service

statestring(InternetAccessServiceState)required

Current state of the service

Enum:"PROVISIONING""PROVISIONED""FAILED""DEPROVISIONING""DEPROVISIONED"
changeobject(InternetAccessChange)required
locationsArray of objects(InternetAccessLocation)

List of locations associated with the service

routingProtocolobject(InternetAccessRoutingProtocol)required
billingobject(InternetAccessBilling)required
accountobject(InternetAccessAccount)required
projectobject(Project)required
orderobject(InternetAccessOrder)required
changeLogobject(Changelog)required

Change log

useCasestring(InternetAccessUseCase)required
Enum:"MAIN""MANAGEMENT_ACCESS"
Response
{
  "href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4",
  "type": "SINGLE_IA",
  "uuid": "673c6e6c-2c36-4488-b3f1-47064357b5b4",
  "name": "internet-access-primary",
  "state": "PROVISIONING",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents"
  },
  "routingProtocol": {
    "type": "BGP",
    "exportPolicy": "FULL",
    "asn": { … },
    "customerRoutes": [ … ],
    "connections": [ … ]
  },
  "billing": {
    "type": "FIXED",
    "enabled": true,
    "startDate": "2026-04-16T00:00:00Z"
  },
  "account": {
    "accountNumber": "57689234",
    "href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234"
  },
  "project": {
    "projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
  },
  "order": {
    "href": "https://api.equinix.com/colocations/v2/orders/100200300",
    "orderNumber": 100200300,
    "purchaseOrderNumber": "PO-98765"
  },
  "changeLog": {
    "createdBy": "api-user",
    "createdDateTime": "2026-04-16T00:00:00Z",
    "updatedBy": "api-user",
    "updatedDateTime": "2026-04-16T00:00:01Z"
  },
  "useCase": "MAIN"
}
Was this page helpful?