Equinix Internet Access API | Equinix Product Documentation

Updates Equinix Internet Access Service

Request

Updates properties of Equinix Internet Access

Security

BearerAuth

Path

serviceIdstring, (uuid)(ServiceId)required

Service identifier

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

Query

dryRunboolean

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

Example:dryRun=true

Bodyapplication/jsonrequired

Array [

opstring, (^(replace|add|remove)$)(ChangeOperationUpdateAllowedOp)required

Operation type. Allowed values:

replace
add
remove

pathstring, (^(\/bandwidth|\/routingProtocol\/(?:ipv4|ipv6)\/(?:customerRoutes\[\*\]|peerings\[\*\]\/(?:equinixPeerIps|equinixVRRPIp)))$)(ChangeOperationUpdateAllowedPath)required

Path inside document leading to updated parameter. Allowed values:

/bandwidth
/routingProtocol/ipv4/customerRoutes[*]
/routingProtocol/ipv6/customerRoutes[*]

Example:"/bandwidth"

valuestringrequired

New value for updated parameter.

Allowed value for PA is prefixLength, e.g. "30" Allowed value for PI is prefix with subnetSize. e.g. "192.168.1.0/24"

orderobject(ServiceOrder)

]

Payload

[
  {
    "op": "string",
    "path": "/bandwidth",
    "value": "string",
    "order": { … }
  }
]

Responses

Accepted update request

Bodyapplication/json

tagsArray of strings

Example:

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

hrefstring, (uri)required

Internet access URI

Example:"https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec"

uuidstring, (uuid)(ServiceId)required

Service identifier

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

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"

namestringrequired

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

Example:"Internet Access"

descriptionstring

Description of the service

Example:"Internet access service"

bandwidthinteger, (int64), >= 1000required

Bandwidth of the service in Mbps

Example:1000

billingstring(ServiceBilling)required

Billing type of service

Enum:"FIXED""USAGE_BASED""BURST_BASED"

Example:"FIXED"

billingEnabledbooleanrequired

Indicates whether the service is billed

billingStartDatestring, (date)

Contains billing start date, if the service is billed

statestring(ServiceState)required

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

changeany(Change)required

changeLogobject(ChangeLog)required

connectionsArray of objects, non-empty(ConnectionReadModel)required

routingProtocolany(RoutingProtocolReadModel)required

locationsArray of objects, non-empty(Location)required

accountobject(Account)required

projectobject(ProjectReadModel)required

orderobject(ServiceOrderReadModel)required

useCasestring(UseCase)required

Enum:"MAIN""BACKUP""MANAGEMENT_ACCESS"

Response

{
  "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",
  "billingEnabled": true,
  "billingStartDate": "2019-08-24",
  "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": { … }
  },
  "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": [
    { … }
  ],
  "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": { … }
  },
  "locations": [
    { … }
  ],
  "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": [ … ],
    "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"
  },
  "useCase": "MAIN"
}