Equinix Internet Access API | Equinix Product Documentation

EIA Service

Equinix Internet Access Service API

Operations

Creates Equinix Internet Access Service

Request

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

Security

BearerAuth

Bodyapplication/jsonrequired

Options for creating Equinix Internet Access Service product

tagsArray of strings

Example:

[
  "tag1",
  "tag2",
  "tag3"
]

namestring, <= 64 characters(ServiceName)

descriptionstring, <= 255 characters(ServiceDescription)

typestring(ServiceType)required

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

Enum:"SINGLE""DUAL"

Example:"SINGLE"

connectionsArray of strings, (uuid), [ 1 .. 2 ] items(ConnectionId)required

Collection of service connections uuids

Example:

[
  "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
]

routingProtocolany(RoutingProtocolRequest)required

orderobject(ServiceOrder)

Payload

{
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "name": "string",
  "description": "string",
  "type": "SINGLE",
  "connections": [
    "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
  ],
  "routingProtocol": {
    "tags": [ … ],
    "type": "DIRECT",
    "name": "WebServers Routes",
    "description": "Routes to customer facing web server\n",
    "ipv4": { … },
    "ipv6": { … }
  },
  "order": {
    "contacts": [ … ],
    "purchaseOrder": { … },
    "referenceNumber": "239384723943",
    "signature": { … }
  }
}

Responses

Equinix Internet Access Service Response

Bodyapplication/json

namestring, <= 64 characters(ServiceName)

descriptionstring, <= 255 characters(ServiceDescription)

typestring(ServiceType)required

Enum:"SINGLE""DUAL"

Example:"SINGLE"

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

Collection of service connections uuids

routingProtocolany(RoutingProtocolReadModel)required

bandwidthinteger

Service bandwidth in Mbps

Example:1000

projectobject(ProjectReadModel)

accountobject(Account)

changeany(Change)required

changeLogobject(ChangeLog)

orderobject(ServiceOrderReadModel)

uuidstring, (uuid)(ServiceId)required

Service identifier

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

statestring(ServiceState)required

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

useCasestring(UseCase)required

Enum:"MAIN""BACKUP""MANAGEMENT_ACCESS"

Response

{
  "name": "string",
  "description": "string",
  "type": "SINGLE",
  "connections": [
    { … }
  ],
  "routingProtocol": {
    "tags": [ … ],
    "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": { … },
    "ipv6": { … },
    "changeLog": { … }
  },
  "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": { … }
  },
  "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": [ … ],
    "purchaseOrder": { … },
    "referenceNumber": "239384723943",
    "signature": { … },
    "href": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "type": "NEW",
    "status": "COMPLETED",
    "changeLog": { … },
    "number": "1-9234239473"
  },
  "uuid": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b",
  "state": "PENDING",
  "useCase": "MAIN"
}