Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Deprovision Equinix Internet Access Service Instance

Deprovision Equinix Internet Access service instances that you no longer need.

Deprovision Equinix Internet Access service

 

Currently, you can deprovision Equinix Internet Access with Fabric and Equinix Internet Access with Network Edge. To deprovision an Equinix Internet Access with Dedicated Port service instance, contact Equinix Service Desk.

Prerequisites​

To deprovision an Equinix Internet Access service instance:

  • Equinix Internet Access Manager role must be assigned to the account used to send API requests. For information on access management, see Assign Roles to Users.
  • The order processing for the service instance that you want to deprovision must be completed (order.status: COMPLETED) and the service instance status must be one of the following: ACTIVE, DRAFT, INACTIVE, PENDING.

Step 1: Authenticate​

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

Sample curl request

curl -X
POST 'https://api.equinix.com/oauth2/v1/token'
-H 'content-type: application/json'
-d '{
    "grant_type": "password",
    "client_id": "ABCDE12345",
    "client_secret": "FGHIJ67890",
    "user_name": "john.doe@example.com",
    "user_password": "jd1@#$"
}'
 

Refer to Generating Client ID and Client Secret for instructions on how to create client ID and client secret. For further details on how to authorize your API requests, see Requesting Access and Refresh tokens.

 

If you don't know your user credentials for Equinix Customer Portal, contact your local Equinix Service Desk.


Step 2: Determine Equinix Internet Access Service Instance Identifier​

Use the Retrieve Equinix Internet Access Service Instances to determine the identifier of a service instance that you want to deprovision.

Sample curl request

curl -X POST 'https://api.equinix.com/internetAccess/v1/services/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/state",
                "operator": "=",
                "values": [
                    "ACTIVE"
                ]
            }
        ]
    }
}'

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 2
    },
    "sort": [
        {
            "direction": "ASC",
            "property": "/name"
        }
    ],
    "data": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64",
            "uuid": "ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64",
            "type": "SINGLE_PORT",
            "name": "EIA dot1q Juniper",
            "bandwidth": 50,
            "billing": "FIXED",
            "state": "ACTIVE",
            "draft": false,
            "useCase": "MAIN",
            "change": {
                "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/changes/07e49217-2575-49c0-bded-7422ea12d7c4",
                "uuid": "07e49217-2575-49c0-bded-7422ea12d7c4",
                "type": "SERVICE_CREATION"
            },
            "changeLog": {
                "createdBy": "890702",
                "createdByFullName": "johnDoe johnDoe",
                "createdByEmail": "johnDoe@nocompany2.com",
                "createdDateTime": "2023-05-09T14:03:38.338900Z",
                "updatedBy": "890702",
                "updatedByFullName": "johnDoe johnDoe",
                "updatedByEmail": "johnDoe@nocompany2.com",
                "updatedDateTime": "2023-05-09T14:03:38.338902Z"
            },
            "connections": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/connections/a8027ab6-57db-4ed4-9f86-9951927fd429",
                    "uuid": "a8027ab6-57db-4ed4-9f86-9951927fd429",
                    "type": "IA_VC",
                    "name": "CONNECTION a8027ab6-57db-4ed4-9f86-9951927fd429",
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-09T14:03:38.338900Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-09T14:03:38.338902Z"
                    },
                    "bandwidth": 50,
                    "aSide": {
                        "accessPoint": {
                            "type": "COLO",
                            "name": "sit-001-200001-CX-DC5-L-Dot1q-STD-10G-PRI-NK-275",
                            "location": {
                                "href": "https://api.equinix.com/internetAccess/v1/ibxs/DC5",
                                "region": "AMER",
                                "metroName": "Ashburn",
                                "metroCode": "DC",
                                "ibx": "DC5"
                            },
                            "port": {
                                "href": "https://api.equinix.com/fabric/v4/ports/c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26",
                                "type": "XF_PORT",
                                "uuid": "c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26"
                            },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 4013
                            }
                        }
                    },
                    "links": []
                }
            ],
            "routingProtocols": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/ba9d90e3-8f86-4d00-8ea0-2c719d6e4b64/routingProtocols/7bed33bc-36c4-4a67-9537-9a500cf803e9",
                    "uuid": "7bed33bc-36c4-4a67-9537-9a500cf803e9",
                    "type": "STATIC",
                    "name": "Routing Protocol static",
                    "ipv4": {
                        "customerRoutes": [
                            {
                                "importPolicy": "PA",
                                "prefix": "51.163.2.128/27",
                                "prefixLength": 27,
                                "ipBlock": {
                                    "href": "https://api.equinix.com/internetAccess/v1/ipBlocks/ea07d743-4753-4be6-98bf-de12130b4141",
                                    "uuid": "ea07d743-4753-4be6-98bf-de12130b4141",
                                    "type": "IA_IP_BLOCK"
                                }
                            }
                        ],
                        "peerings": [
                            {
                                "connections": [],
                                "customerPeerIps": [
                                    "51.163.7.250/30"
                                ],
                                "peerSubnet": {
                                    "prefix": "51.163.7.248/30",
                                    "prefixLength": 30
                                },
                                "vrrpEnabled": false,
                                "equinixPeerIps": [
                                    "51.163.7.249/30"
                                ]
                            }
                        ]
                    },
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-09T14:03:38.338900Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-09T14:03:38.338902Z"
                    },
                    "links": []
                }
            ],
            "account": {
                "href": "https://api.equinix.com/internetAccess/v1/accounts/200001",
                "accountNumber": "200001",
                "accountName": ""
            },
            "project": {
                "href": "https://api.equinix.com/resourceManager/v2/projects/6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectName": "Project-22999",
                "parentOrganizationId": "43ecef86-ec2b-43c9-b7c0-74229e464780",
                "parentOrganizationName": "sit-001-200001a"
            },
            "order": {
                "href": "https://api.equinix.com/internetAccess/v1/orders/bbd5a2bb-9bc8-4e1a-871e-4ee7e00f3ecd",
                "uuid": "bbd5a2bb-9bc8-4e1a-871e-4ee7e00f3ecd",
                "type": "AMENDMENT",
                "draft": false,
                "status": "COMPLETED",
                "changeLog": {
                    "createdBy": "890702",
                    "createdByFullName": "johnDoe johnDoe",
                    "createdByEmail": "johnDoe@nocompany2.com",
                    "createdDateTime": "2023-05-09T14:02:27.721774Z",
                    "updatedBy": "890702",
                    "updatedByFullName": "johnDoe johnDoe",
                    "updatedByEmail": "johnDoe@nocompany2.com",
                    "updatedDateTime": "2023-05-09T14:02:27.721774Z"
                },
                "number": "1-223399842012",
                "contacts": [
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "TECHNICAL",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "NOTIFICATION",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "ORDERING",
                        "registeredUser": "johnDoe",
                        "details": []
                    }
                ],
                "links": []
            },
            "links": []
        },
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e",
            "uuid": "1416e55b-f9ee-4867-9ebe-e785a0295d7e",
            "type": "SINGLE_PORT",
            "name": "EIA dot1q Juniper",
            "bandwidth": 50,
            "billing": "FIXED",
            "state": "ACTIVE",
            "draft": false,
            "useCase": "MAIN",
            "change": {
                "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e/changes/3026b1ff-7e94-436f-a737-b71b1ae2312b",
                "uuid": "3026b1ff-7e94-436f-a737-b71b1ae2312b",
                "type": "SERVICE_CREATION"
            },
            "changeLog": {
                "createdBy": "890702",
                "createdByFullName": "johnDoe johnDoe",
                "createdByEmail": "johnDoe@nocompany2.com",
                "createdDateTime": "2023-05-10T11:26:55.038309Z",
                "updatedBy": "890702",
                "updatedByFullName": "johnDoe johnDoe",
                "updatedByEmail": "johnDoe@nocompany2.com",
                "updatedDateTime": "2023-05-10T11:26:55.038311Z"
            },
            "connections": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e/connections/b8ea019b-ee47-44c4-9442-006e34ba8f82",
                    "uuid": "b8ea019b-ee47-44c4-9442-006e34ba8f82",
                    "type": "IA_VC",
                    "name": "CONNECTION b8ea019b-ee47-44c4-9442-006e34ba8f82",
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-10T11:26:55.038309Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-10T11:26:55.038311Z"
                    },
                    "bandwidth": 50,
                    "aSide": {
                        "accessPoint": {
                            "type": "COLO",
                            "name": "sit-001-200001-CX-DC5-L-Dot1q-STD-10G-PRI-NK-275",
                            "location": {
                                "href": "https://api.equinix.com/internetAccess/v1/ibxs/DC5",
                                "region": "AMER",
                                "metroName": "Ashburn",
                                "metroCode": "DC",
                                "ibx": "DC5"
                            },
                            "port": {
                                "href": "https://api.equinix.com/fabric/v4/ports/c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26",
                                "type": "XF_PORT",
                                "uuid": "c4d85dbe-fa2a-a2a9-f7e0-306a5c00af26"
                            },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 4015
                            }
                        }
                    },
                    "links": []
                }
            ],
            "routingProtocols": [
                {
                    "href": "https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e/routingProtocols/d72885ad-3ebc-4856-b5f6-529ee8c29b0c",
                    "uuid": "d72885ad-3ebc-4856-b5f6-529ee8c29b0c",
                    "type": "STATIC",
                    "name": "Routing Protocol static",
                    "ipv4": {
                        "customerRoutes": [
                            {
                                "importPolicy": "PA",
                                "prefix": "142.215.114.0/27",
                                "prefixLength": 27,
                                "ipBlock": {
                                    "href": "https://api.equinix.com/internetAccess/v1/ipBlocks/b7cc54e6-3f31-488a-ab98-51e02f64d8ad",
                                    "uuid": "b7cc54e6-3f31-488a-ab98-51e02f64d8ad",
                                    "type": "IA_IP_BLOCK"
                                }
                            }
                        ],
                        "peerings": [
                            {
                                "connections": [],
                                "customerPeerIps": [
                                    "142.215.188.118/30"
                                ],
                                "peerSubnet": {
                                    "prefix": "142.215.188.116/30",
                                    "prefixLength": 30
                                },
                                "vrrpEnabled": false,
                                "equinixPeerIps": [
                                    "142.215.188.117/30"
                                ]
                            }
                        ]
                    },
                    "changeLog": {
                        "createdBy": "890702",
                        "createdByFullName": "johnDoe johnDoe",
                        "createdByEmail": "johnDoe@nocompany2.com",
                        "createdDateTime": "2023-05-10T11:26:55.038309Z",
                        "updatedBy": "890702",
                        "updatedByFullName": "johnDoe johnDoe",
                        "updatedByEmail": "johnDoe@nocompany2.com",
                        "updatedDateTime": "2023-05-10T11:26:55.038311Z"
                    },
                    "links": []
                }
            ],
            "account": {
                "href": "https://api.equinix.com/internetAccess/v1/accounts/200001",
                "accountNumber": "200001",
                "accountName": ""
            },
            "project": {
                "href": "https://api.equinix.com/resourceManager/v2/projects/6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectId": "6548320d-866b-4fdf-9b05-dcbe95f43bb1",
                "projectName": "Project-22999",
                "parentOrganizationId": "43ecef86-ec2b-43c9-b7c0-74229e464780",
                "parentOrganizationName": "sit-001-200001a"
            },
            "order": {
                "href": "https://api.equinix.com/internetAccess/v1/orders/960643a1-0983-476e-a3da-e4fc2952ec39",
                "uuid": "960643a1-0983-476e-a3da-e4fc2952ec39",
                "type": "AMENDMENT",
                "draft": false,
                "status": "COMPLETED",
                "changeLog": {
                    "createdBy": "890702",
                    "createdByFullName": "johnDoe johnDoe",
                    "createdByEmail": "johnDoe@nocompany2.com",
                    "createdDateTime": "2023-05-10T11:25:03.318122Z",
                    "updatedBy": "890702",
                    "updatedByFullName": "johnDoe johnDoe",
                    "updatedByEmail": "johnDoe@nocompany2.com",
                    "updatedDateTime": "2023-05-10T11:25:03.318122Z"
                },
                "number": "1-223573608868",
                "contacts": [
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "TECHNICAL",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "NOTIFICATION",
                        "registeredUser": "johnDoe",
                        "details": []
                    },
                    {
                        "href": "https://api.equinix.com/access/v2/users/johnDoe",
                        "type": "ORDERING",
                        "registeredUser": "johnDoe",
                        "details": []
                    }
                ],
                "links": []
            },
            "links": []
        }
        
    ]
}

Step 3: Delete Equinix Internet Access Service Instance​

Use the Delete Equinix Internet Access Service Instance to deprovision a specified EIA service instance.

 

Deleting an Equinix Internet Access with Network Edge service instance also deprovisions the associated Fabric connection between the Network Edge device and the EIA service profile.

Sample curl request

curl -X DELETE 'https://api.equinix.com/internetAccess/v1/services/1416e55b-f9ee-4867-9ebe-e785a0295d7e'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
 

You can use dryRun query parameter to execute the API request in test mode and determine if the user account has sufficient permissions to delete the given service instance.


Sample response

{
    "type": "SINGLE_PORT",
    "useCase": "MAIN",
    "name": "EIA dot1q Juniper",
    "bandwidth": 50,
    "uuid": "1416e55b-f9ee-4867-9ebe-e785a0295d7e",
    "account": {
        "accountNumber": "200491"
    },
    "billing": "FIXED",
    "changeLog": {
        "createdBy": "890702",
        "createdByFullName": "johnDoe johnDoe",
        "createdByEmail": "johnDoe@nocompany2.com",
        "createdDateTime": "2023-05-10T11:26:55.038309Z",
        "updatedBy": "890702",
        "updatedByFullName": "johnDoe johnDoe",
        "updatedByEmail": "johnDoe@nocompany2.com",
        "updatedDateTime": "2023-05-10T11:26:55.038311Z",
        "deletedBy": "890702",
        "deletedByFullName": "johnDoe johnDoe",
        "deletedByEmail": "johnDoe@nocompany2.com",
        "deletedDateTime": "2023-09-09T12:34:56.038311Z"
    },
    "draft": false,
    "links": [
        {
            "href": "https://api.equinix.com/internetAccess/v1/services/31c30c26-548e-4056-b92a-a15dd3cc6aae",
            "authenticate": false
        }
    ],
    "order": {
        "href": "https://api.equinix.com/internetAccess/v1/orders/d78b048c-0ccb-4158-a6e0-2c4cc752f806",
        "uuid": "d78b048c-0ccb-4158-a6e0-2c4cc752f806",
        "type": "AMENDMENT"
    },
    "project": {
        "href": "https://api.equinix.com/resourceManager/v1/projects/ad419c0f-bb03-45be-9753-e828c555fea9",
        "projectId": "ad419c0f-bb03-45be-9753-e828c555fea9"
    },
    "state": "DEPROVISIONING"
}