Skip to main content
Loading...

API docs by

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
typestring(ServiceType)required

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

Enum:"SINGLE_PORT""DUAL_PORT"
Example:"SINGLE_PORT"
useCasestring(UseCaseType)required

Service use case

Enum:"MAIN""BACKUP""MANAGEMENT_ACCESS"
Example:"MAIN"
namestringrequired

Name of the service instance

Example:"WebServers"
descriptionstring

Description of the service instance

Example:"Customer facing web servers\n"
bandwidthintegerrequired

Service bandwidth in Mbps

Example:10000
minBandwidthCommitinteger, >= 0

Service min bandwidth commit in Mbps

Example:500
billingstring(BillingType)

Type of billing

Default:"FIXED"
Enum:"FIXED""USAGE_BASED""BURST_BASED"
connectionsArray of objects, [ 1 .. 2 ] items(Connection)required

Collection of service connections

draftboolean
Default:false
routingProtocolsArray of objects, = 1 items(RoutingProtocolRequest)required

Collection of routing protocols

orderobject(ServiceOrderRequest)
accountobject(CustomerBillingAccount)required
projectobject(Project)
Payload
{
  "tags": [
    "string"
  ],
  "type": "SINGLE_PORT",
  "useCase": "MAIN",
  "name": "WebServers",
  "description": "Customer facing web servers\n",
  "bandwidth": 10000,
  "minBandwidthCommit": 500,
  "billing": "FIXED",
  "connections": [
    { … }
  ],
  "draft": false,
  "routingProtocols": [
    { … }
  ],
  "order": {
    "tags": [ … ],
    "contacts": [ … ],
    "draft": false,
    "purchaseOrder": { … },
    "referenceNumber": "239384723943",
    "signature": { … }
  },
  "account": {
    "accountNumber": "2-57689234"
  },
  "project": {
    "projectId": "7348"
  }
}

Responses

Equinix Internet Access Service Response

Bodyapplication/json
tagsArray of strings
typestring(ServiceType)required

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

Enum:"SINGLE_PORT""DUAL_PORT"
Example:"SINGLE_PORT"
useCasestring(UseCaseType)required

Service use case

Enum:"MAIN""BACKUP""MANAGEMENT_ACCESS"
Example:"MAIN"
namestringrequired

Name of the service instance

Example:"WebServers"
descriptionstring

Description of the service instance

Example:"Customer facing web servers\n"
bandwidthintegerrequired

Service bandwidth in Mbps

Example:10000
minBandwidthCommitinteger, >= 0

Service min bandwidth commit in Mbps

Example:500
uuidstring, (uuid)required
accountobject(CustomerAccountReference)
billingstring(BillingType)required

Type of billing

Default:"FIXED"
Enum:"FIXED""USAGE_BASED""BURST_BASED"
changeLogobject(ServiceChangeLog)
draftbooleanrequired
Default:false
orderobject(ServiceOrderReference)
projectobject(ProjectReference)
statestring(ServiceState)required
Enum:"DRAFT""PENDING""PROVISIONING""ACTIVE""INACTIVE""DEPROVISIONING""DEPROVISIONED""FAILED"
Response
{
  "tags": [
    "string"
  ],
  "type": "SINGLE_PORT",
  "useCase": "MAIN",
  "name": "WebServers",
  "description": "Customer facing web servers\n",
  "bandwidth": 10000,
  "minBandwidthCommit": 500,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "account": {
    "accountNumber": "2-57689234"
  },
  "billing": "FIXED",
  "changeLog": {
    "createdBy": "string",
    "createdByFullName": "string",
    "createdByEmail": "user@example.com",
    "createdDateTime": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedByFullName": "string",
    "updatedByEmail": "user@example.com",
    "updatedDateTime": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "deletedByFullName": "string",
    "deletedByEmail": "user@example.com",
    "deletedDateTime": "2019-08-24T14:15:22Z"
  },
  "draft": false,
  "links": [
    { … }
  ],
  "order": {
    "href": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "type": "NEW"
  },
  "project": {
    "href": "string",
    "projectId": "7348"
  },
  "state": "DRAFT"
}
Was this page helpful?