Equinix Internet Access API | Equinix Product Documentation

Deletes Equinix Internet Access Service

Request

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

Security

BearerAuth

Path

serviceIdstring, (uuid)required

Service identifier

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

Query

dryRunboolean

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

Example:dryRun=true

Payload

// No request payload

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

linksArray of objects(Link)

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"
}