Get all services

List all services currently commissioned through CloudLX.

Request

Endpoint: /api/services
Method: GET
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Response

Example:

                                
    {
        "services": [
            {
                "id": 196,
                "name": "Azure Test",
                "vlan": 101,
                "nni_vlan": 3600,
                "created": "2015-12-03 15:55:13",
                "expires": "2015-12-04 15:55:13",
                "bandwidth": "200Mbps",
                "paused": false,
                "expired": false,
                "type": "Microsoft Azure",
                "port": {
                    "id": 219,
                    "name": "Test NYC Port 1",
                    "index": 18,
                    "switch": {
                        "id": 1,
                        "index": 1
                    },
                    "slot": {
                        "id": 1,
                        "index": 1
                    },
                    "shelf": {
                        "id": 1,
                        "index": 1
                    }
                }
            }
        ]
    }
                                
                            
services Description Array containing the list of services
Type Array
id Description The CloudLX ID for the service
Type Integer
Example 10
name Description The friendly name given to the service
Type Text
Example Azure Text
vlan Description The C-Vlan the service is operating on
Type Integer
Example 101
nni_vlan Description The NNI VLAN being used if the service is connected to an NNI interface
Type Integer
Example 3600
created Description Timestamp of when the service was created
Type Timestamp
Example 2015-12-03 15:55:13
expires Description Timestamp of when the service is due to expire
Type Timestamp
Example 2015-12-04 15:55:13
type Description A string representing the service type
Type String
Example Microsoft Azure
port Description Port object of the customer port the service is attached to
Type Array

Back to top