Before configuring any network services in Console Connect, you must create a port. This is a two-step process; ordering or requesting a port, then activating that port. Console Connect manages entitlements through plan-based subscriptions associated with each port (one subscription per port). Before you can order a port, your company must have a subscription to a plan with sufficient entitlements available to complete the request. To list your company’s subscriptions and entitlements refer to Get all plans and entitlements.
Console Connect supports ordering 1G and 10G ports. Port availability is dependent on the Data Center. Prerequisites:
curl \
--request PUT \
--header "Content-Type: application/json" \
--header "Authorization: Bearer [[api key]]" \
--data-binary "{\"dataCenterFacility\":\"supernetpa4\",\"billingId\":56d691309a90128d55831db2,\"speed\":1000,\"portName\":\"PORT_2\",\"type\":\"PHYSICAL\"}" \
https://api.consoleconnect.com/api/company/:companyName/ports/orders
The port will remain in a pending status until it is approved by a Console Connect administrator. Once approved, it will be automatically provisioned and activated. Ports may be disabled or re-activated using these requests More information on Ports
Prerequisites:
The following request will update the port name:
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer [[api key]]" \
--data-binary "{\"name\":\"My new name\"}" \
https://api.consoleconnect.com/api/company/:companyUsername/ports/:portId
Ports can be disabled with the following request:
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer [[api key]]" \
https://api.consoleconnect.com/api/company/:companyName/ports/:portId/:disable
Ports must be disabled before they can be deleted. Once disabled, the following request will delete the port:
curl \
--request DELETE --header "Content-Type: application/json" \
--header "Authorization: Bearer [[api key]]" \
https://api.consoleconnect.com/api/company/:companyUsername/ports/:portId
A port order is created in a 'dataCenterFacility'.
The 'paymentType' field is required and needs to be one of 'plan', or 'invoice'. The 'creditcard' payment type is only supported via the Console Connect web application.
When paymentType is 'plan' or 'invoice', 'paymentTransactionId' should not be provided. When paymentType is "creditcard", paymentTransactionId must be provided.
When the port is provisioned, the order will change to "done" status and a new port will be created and activated.
OK
{- "dataCenterFacility": "supernetpa4",
- "speed": "1000",
- "portName": "PORT_2",
- "paymentType": "plan",
- "paymentTransactionId": "56d691309a90128d55831db2"
}
{- "billingId": "56d691309a90128d55831db2",
- "cancelled": false,
- "cancelledAt": "1970-01-01T00:00:00.000Z",
- "cancelledBy": null,
- "company": {
- "tags": [ ],
- "__v": 0,
- "avatar": null,
- "avatarId": null,
- "background": null,
- "capabilities": {
- "layer2": false,
- "layer2Metros": [ ],
- "layer2Regions": [ ],
- "layer3": false,
- "layer3Metros": [ ],
- "layer3Regions": [ ]
}, - "companies": [ ],
- "company": {
- "address": null,
- "addresses": [ ],
- "businessDevelopmentManagerTypePreference": "UNSPECIFIED",
- "businessRegistrationCertReference": null,
- "businessRegistrationCertRejectedReason": null,
- "businessRegistrationCertUploadedAt": null,
- "businessRegistrationCertVerified": "UNVERIFIED",
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "dateFounded": null,
- "emailDomains": [
- "example.org"
], - "fax": null,
- "first": null,
- "industry": null,
- "isSDWAN": false,
- "last": null,
- "parentIds": [ ],
- "phone": null,
- "privacy": {
- "community": {
- "blackListIds": [ ],
- "mode": "PUBLIC",
- "whiteListIds": [ ]
}, - "network": {
- "blackListIds": [ ],
- "mode": "PUBLIC",
- "whiteListIds": [ ]
}
}, - "regionalInternetRegistry": [ ],
- "registeredName": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2017-02-06T23:20:46.291Z",
- "defaultPaymentType": null,
- "deleted": false,
- "deletedAt": null,
- "displayOrder": -299,
- "groups": [ ],
- "headline": null,
- "id": "58980a25a77b4d7bf459d200",
- "isSupport": false,
- "legalEntityId": null,
- "linkUserCompany": { },
- "location": null,
- "name": "Company 1",
- "online": false,
- "optIntoMarketingEmail": false,
- "overviewImage": null,
- "phone": null,
- "popIds": [ ],
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "system": {
- "welcomeMessage": null
}, - "type": "COMPANY",
- "updatedAt": "2017-02-06T23:20:46.291Z",
- "username": "company1",
- "verified": true,
- "verifiedIdentity": true
}, - "controller": {
- "asn": null,
- "cerAsn": null,
- "cerIp": {
- "ipv4": null,
- "ipv6": null
}, - "id": null,
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "serviceLayerId": null,
- "vlan": null
}, - "createdAt": "2016-03-02T07:07:28.195Z",
- "createdBy": "stan",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "deletedBy": null,
- "id": "56d691309a90128d55831db1",
- "locationId": null,
- "message": null,
- "metro": {
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "id": "1232413986c08c061dd8c45f",
- "name": "SJC",
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "port": {
- "activeChangedAt": "2016-03-02T07:07:27.147Z",
- "createdAt": "2016-03-02T07:07:27.148Z",
- "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "56d6912f9a90128d55831da8",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "name": "PORT_1",
- "portId": null,
- "speed": 1000,
- "status": "UNKNOWN",
- "type": "PHYSICAL_NSP",
- "updatedAt": "2016-03-02T07:07:27.148Z",
- "vlan": null
}, - "portName": "PORT_1",
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "created",
- "updatedAt": "2016-03-02T07:07:28.195Z",
- "updatedBy": null
}
Get the details of a companies port order
OK
{- "orderId": "56d691309a90128d55831db1",
- "companyName": "Acme"
}
{- "billingId": "56d691309a90128d55831db2",
- "cancelled": false,
- "cancelledAt": "1970-01-01T00:00:00.000Z",
- "cancelledBy": null,
- "company": {
- "tags": [ ],
- "__v": 0,
- "avatar": null,
- "avatarId": null,
- "background": null,
- "capabilities": {
- "layer2": false,
- "layer2Metros": [ ],
- "layer2Regions": [ ],
- "layer3": false,
- "layer3Metros": [ ],
- "layer3Regions": [ ]
}, - "companies": [ ],
- "company": {
- "address": null,
- "addresses": [ ],
- "businessDevelopmentManagerTypePreference": "UNSPECIFIED",
- "businessRegistrationCertReference": null,
- "businessRegistrationCertRejectedReason": null,
- "businessRegistrationCertUploadedAt": null,
- "businessRegistrationCertVerified": "UNVERIFIED",
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "dateFounded": null,
- "emailDomains": [
- "example.com"
], - "fax": null,
- "first": null,
- "industry": null,
- "isSDWAN": false,
- "last": null,
- "parentIds": [ ],
- "phone": null,
- "privacy": {
- "community": {
- "blackListIds": [ ],
- "mode": "PUBLIC",
- "whiteListIds": [ ]
}, - "network": {
- "blackListIds": [ ],
- "mode": "PUBLIC",
- "whiteListIds": [ ]
}
}, - "regionalInternetRegistry": [ ],
- "registeredName": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2017-02-06T23:20:46.291Z",
- "defaultPaymentType": null,
- "deleted": false,
- "deletedAt": null,
- "displayOrder": -299,
- "groups": [ ],
- "headline": null,
- "id": "58980a25a77b4d7bf459d200",
- "isSupport": false,
- "legalEntityId": null,
- "linkUserCompany": { },
- "location": null,
- "name": "Company 1",
- "online": false,
- "optIntoMarketingEmail": false,
- "overviewImage": null,
- "phone": null,
- "popIds": [ ],
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "system": {
- "welcomeMessage": null
}, - "type": "COMPANY",
- "updatedAt": "2017-02-06T23:20:46.291Z",
- "username": "company1",
- "verified": true,
- "verifiedIdentity": true
}, - "controller": {
- "asn": null,
- "cerAsn": null,
- "cerIp": {
- "ipv4": null,
- "ipv6": null
}, - "id": null,
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "serviceLayerId": null,
- "vlan": null
}, - "createdAt": "2016-03-02T07:07:28.195Z",
- "createdBy": "stan",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "deletedBy": null,
- "id": "56d691309a90128d55831db1",
- "locationId": null,
- "message": null,
- "metro": {
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "id": "1232413986c08c061dd8c45f",
- "name": "SJC",
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "port": {
- "activeChangedAt": "2016-03-02T07:07:27.147Z",
- "createdAt": "2016-03-02T07:07:27.148Z",
- "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "56d6912f9a90128d55831da8",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "name": "PORT_1",
- "portId": null,
- "speed": 1000,
- "status": "UNKNOWN",
- "type": "PHYSICAL_NSP",
- "updatedAt": "2016-03-02T07:07:27.148Z",
- "vlan": null
}, - "portName": "PORT_1",
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "created",
- "updatedAt": "2016-03-02T07:07:28.195Z",
- "updatedBy": null
}
A Letter of Authorisation is required as part of the process to connect to a port.
OK
{- "billingId": "56d691309a90128d55831db2",
- "cancelled": false,
- "cancelledAt": "1970-01-01T00:00:00.000Z",
- "cancelledBy": null,
- "company": {
- "tags": [ ],
- "__v": 0,
- "avatar": null,
- "avatarId": null,
- "background": null,
- "capabilities": {
- "layer2": false,
- "layer2Metros": [ ],
- "layer2Regions": [ ],
- "layer3": false,
- "layer3Metros": [ ],
- "layer3Regions": [ ]
}, - "companies": [ ],
- "company": {
- "address": null,
- "addresses": [ ],
- "businessDevelopmentManagerTypePreference": "UNSPECIFIED",
- "businessRegistrationCertReference": null,
- "businessRegistrationCertRejectedReason": null,
- "businessRegistrationCertUploadedAt": null,
- "businessRegistrationCertVerified": "UNVERIFIED",
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "dateFounded": null,
- "emailDomains": [
- "example.org"
], - "fax": null,
- "first": null,
- "industry": null,
- "isSDWAN": false,
- "last": null,
- "parentIds": [ ],
- "phone": null,
- "privacy": {
- "community": {
- "blackListIds": [ ],
- "mode": "PUBLIC",
- "whiteListIds": [ ]
}, - "network": {
- "blackListIds": [ ],
- "mode": "PUBLIC",
- "whiteListIds": [ ]
}
}, - "regionalInternetRegistry": [ ],
- "registeredName": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2017-02-06T23:20:46.291Z",
- "defaultPaymentType": null,
- "deleted": false,
- "deletedAt": null,
- "displayOrder": -299,
- "groups": [ ],
- "headline": null,
- "id": "58980a25a77b4d7bf459d200",
- "isSupport": false,
- "legalEntityId": null,
- "linkUserCompany": { },
- "location": null,
- "name": "Company 1",
- "online": false,
- "optIntoMarketingEmail": false,
- "overviewImage": null,
- "phone": null,
- "popIds": [ ],
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "system": {
- "welcomeMessage": null
}, - "type": "COMPANY",
- "updatedAt": "2017-02-06T23:20:46.291Z",
- "username": "company1",
- "verified": true,
- "verifiedIdentity": true
}, - "controller": {
- "asn": null,
- "cerAsn": null,
- "cerIp": {
- "ipv4": null,
- "ipv6": null
}, - "id": null,
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "serviceLayerId": null,
- "vlan": null
}, - "createdAt": "2016-03-02T07:07:28.195Z",
- "createdBy": "stan",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "deletedBy": null,
- "id": "56d691309a90128d55831db1",
- "locationId": null,
- "message": null,
- "metro": {
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "id": "1232413986c08c061dd8c45f",
- "name": "SJC",
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "port": {
- "activeChangedAt": "2016-03-02T07:07:27.147Z",
- "createdAt": "2016-03-02T07:07:27.148Z",
- "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "56d6912f9a90128d55831da8",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "name": "PORT_1",
- "portId": null,
- "speed": 1000,
- "status": "UNKNOWN",
- "type": "PHYSICAL_NSP",
- "updatedAt": "2016-03-02T07:07:27.148Z",
- "vlan": null
}, - "portName": "PORT_1",
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "created",
- "updatedAt": "2016-03-02T07:07:28.195Z",
- "updatedBy": null
}
Note: Reading a company’s ports is publicly visible.
A port can be in one of the following states:
Status | Description |
---|---|
ACTIVATING | In the process of being activated |
READY | Allocated but awaiting a physical network connection |
ACTIVE | Port is active |
DISABLING | In the process of being disabled |
DISABLED | The port is disabled |
DELETING | In the process of being deleted |
DELETED | The Port is deleted |
UNKNOWN | The status of the port cannot be determined |
ONBOARDING | The port is currently being on-boarded |
In addition to these states, a port also has the singleService
flag which indicates that the port is dedicated to a single untagged connection, so no further connections can be created on the port.
OK
{- "results": [
- {
- "activeChangedAt": "2016-06-16T06:20:10.640Z",
- "asn": {
- "asn": "176251",
- "createdAt": "2016-06-16T06:20:11.053Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "ALLOCATED",
- "updatedAt": "2016-06-16T06:20:11.053Z"
}, - "capacity": {
- "remaining": 900,
- "total": 1000,
- "utilised": 100
}, - "company": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [ ],
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2016-06-16T06:20:09.604Z",
- "deleted": false,
- "deletedAt": null,
- "groups": null,
- "headline": null,
- "id": "5762451982894b9b1b1a5dbc",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "corp",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "COMPANY",
- "updatedAt": "2016-06-16T06:20:09.604Z",
- "username": "corp",
- "verified": false
}, - "companyId": "5762451982894b9b1b1a5dbc",
- "connections": [
- {
- "id": "5762451d82894b9b1b1a5dd2",
- "name": "Sierra",
- "status": "ACTIVE"
}
], - "controllers": [
- {
- "activeChangedAt": "2016-06-16T06:20:11.458Z",
- "asn": {
- "asn": "54321",
- "createdAt": "2016-06-16T06:20:11.460Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "SYSTEM",
- "updatedAt": "2016-06-16T06:20:11.460Z"
}, - "createdAt": "2016-06-16T06:20:11.114Z",
- "deleted": false,
- "deletedAt": null,
- "id": "5762451b82894b9b1b1a5dc6",
- "ip": {
- "ipv4": "198.51.100.1",
- "ipv6": "2001:DB8::1111:1111:1111:1111"
}, - "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "corp - Skyla",
- "password": "",
- "portIds": [
- "5762451a82894b9b1b1a5dc2"
], - "status": "ACTIVE",
- "type": "USER",
- "updatedAt": "2016-06-16T06:20:11.462Z",
- "vlan": 200
}
], - "createdAt": "2016-06-16T06:20:10.029Z",
- "dataCenterFacility": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [
- {
- "address": "11 Great Oaks Boulevard",
- "city": "San Jose",
- "country": "USA",
- "email": "",
- "geo": {
- "coordinates": [
- -121.78322,
- 37.24162
], - "type": "Point"
}, - "phone": "",
- "primary": true,
- "state": "California",
- "zip": "95119-1242"
}
], - "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2015-11-04T06:07:12.785Z",
- "dataCenterFacility": {
- "id": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "ready": true,
- "speeds": [ ]
}, - "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "groups": null,
- "headline": null,
- "id": "5126c9f1111e15a24a066130",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "Equinix - SV1",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 0,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "DATA_CENTER_FACILITY",
- "updatedAt": "2015-11-04T06:07:13.430Z",
- "username": "equinix-sv1",
- "verified": true
}, - "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "5762451a82894b9b1b1a5dc2",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "Vicente",
- "networkServiceProviderId": null,
- "partner": {
- "regionNames": [ ],
- "type": "NONE"
}, - "portId": null,
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "ACTIVE",
- "type": "PHYSICAL",
- "updatedAt": "2016-06-16T06:20:11.116Z",
- "vlanRanges": [
- {
- "end": 3699,
- "start": 3600
}
]
}
]
}
Note: Reading a company's port details is publicly visible.
OK
{- "activeChangedAt": "2016-06-16T06:20:10.640Z",
- "asn": {
- "asn": "176251",
- "createdAt": "2016-06-16T06:20:11.053Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "ALLOCATED",
- "updatedAt": "2016-06-16T06:20:11.053Z"
}, - "capacity": {
- "remaining": 900,
- "total": 1000,
- "utilised": 100
}, - "company": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [ ],
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2016-06-16T06:20:09.604Z",
- "deleted": false,
- "deletedAt": null,
- "groups": null,
- "headline": null,
- "id": "5762451982894b9b1b1a5dbc",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "corp",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "COMPANY",
- "updatedAt": "2016-06-16T06:20:09.604Z",
- "username": "corp",
- "verified": false
}, - "companyId": "5762451982894b9b1b1a5dbc",
- "connections": [
- {
- "id": "5762451d82894b9b1b1a5dd2",
- "name": "Sierra",
- "status": "ACTIVE"
}
], - "controllers": [
- {
- "activeChangedAt": "2016-06-16T06:20:11.458Z",
- "asn": {
- "asn": "54321",
- "createdAt": "2016-06-16T06:20:11.460Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "SYSTEM",
- "updatedAt": "2016-06-16T06:20:11.460Z"
}, - "createdAt": "2016-06-16T06:20:11.114Z",
- "deleted": false,
- "deletedAt": null,
- "id": "5762451b82894b9b1b1a5dc6",
- "ip": {
- "ipv4": "198.51.100.1",
- "ipv6": "2001:DB8::1111:1111:1111:1111"
}, - "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "corp - Skyla",
- "password": "",
- "portIds": [
- "5762451a82894b9b1b1a5dc2"
], - "status": "ACTIVE",
- "type": "USER",
- "updatedAt": "2016-06-16T06:20:11.462Z",
- "vlan": 200
}
], - "createdAt": "2016-06-16T06:20:10.029Z",
- "dataCenterFacility": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [
- {
- "address": "11 Great Oaks Boulevard",
- "city": "San Jose",
- "country": "USA",
- "email": "",
- "geo": {
- "coordinates": [
- -121.78322,
- 37.24162
], - "type": "Point"
}, - "phone": "",
- "primary": true,
- "state": "California",
- "zip": "95119-1242"
}
], - "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2015-11-04T06:07:12.785Z",
- "dataCenterFacility": {
- "id": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "ready": true,
- "speeds": [ ]
}, - "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "groups": null,
- "headline": null,
- "id": "5126c9f1111e15a24a066130",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "Equinix - SV1",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 0,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "DATA_CENTER_FACILITY",
- "updatedAt": "2015-11-04T06:07:13.430Z",
- "username": "equinix-sv1",
- "verified": true
}, - "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "5762451a82894b9b1b1a5dc2",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "Vicente",
- "networkServiceProviderId": null,
- "partner": {
- "regionNames": [ ],
- "type": "NONE"
}, - "portId": null,
- "singleService": false,
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "ACTIVE",
- "type": "PHYSICAL",
- "updatedAt": "2016-06-16T06:20:11.116Z",
- "vlanRange": [
- {
- "from": 3600,
- "to": 3699
}
]
}
Update a port
OK
{- "asn": {
- "asn": "176252"
}, - "name": "VPort0"
}
{- "activeChangedAt": "2016-06-16T06:20:10.640Z",
- "asn": {
- "asn": "176251",
- "createdAt": "2016-06-16T06:20:11.053Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "ALLOCATED",
- "updatedAt": "2016-06-16T06:20:11.053Z"
}, - "capacity": {
- "remaining": 900,
- "total": 1000,
- "utilised": 100
}, - "company": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [ ],
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2016-06-16T06:20:09.604Z",
- "deleted": false,
- "deletedAt": null,
- "groups": null,
- "headline": null,
- "id": "5762451982894b9b1b1a5dbc",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "corp",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "COMPANY",
- "updatedAt": "2016-06-16T06:20:09.604Z",
- "username": "corp",
- "verified": false
}, - "companyId": "5762451982894b9b1b1a5dbc",
- "connections": [
- {
- "id": "5762451d82894b9b1b1a5dd2",
- "name": "Sierra",
- "status": "ACTIVE"
}
], - "controllers": [
- {
- "activeChangedAt": "2016-06-16T06:20:11.458Z",
- "asn": {
- "asn": "54321",
- "createdAt": "2016-06-16T06:20:11.460Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "SYSTEM",
- "updatedAt": "2016-06-16T06:20:11.460Z"
}, - "createdAt": "2016-06-16T06:20:11.114Z",
- "deleted": false,
- "deletedAt": null,
- "id": "5762451b82894b9b1b1a5dc6",
- "ip": {
- "ipv4": "198.51.100.1",
- "ipv6": "2001:DB8::1111:1111:1111:1111"
}, - "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "corp - Skyla",
- "password": "",
- "portIds": [
- "5762451a82894b9b1b1a5dc2"
], - "status": "ACTIVE",
- "type": "USER",
- "updatedAt": "2016-06-16T06:20:11.462Z",
- "vlan": 200
}
], - "createdAt": "2016-06-16T06:20:10.029Z",
- "dataCenterFacility": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [
- {
- "address": "11 Great Oaks Boulevard",
- "city": "San Jose",
- "country": "USA",
- "email": "",
- "geo": {
- "coordinates": [
- -121.78322,
- 37.24162
], - "type": "Point"
}, - "phone": "",
- "primary": true,
- "state": "California",
- "zip": "95119-1242"
}
], - "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2015-11-04T06:07:12.785Z",
- "dataCenterFacility": {
- "id": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "ready": true,
- "speeds": [ ]
}, - "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "groups": null,
- "headline": null,
- "id": "5126c9f1111e15a24a066130",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "Equinix - SV1",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 0,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "DATA_CENTER_FACILITY",
- "updatedAt": "2015-11-04T06:07:13.430Z",
- "username": "equinix-sv1",
- "verified": true
}, - "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "5762451a82894b9b1b1a5dc2",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "Vicente",
- "networkServiceProviderId": null,
- "partner": {
- "regionNames": [ ],
- "type": "NONE"
}, - "portId": null,
- "singleService": false,
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "ACTIVE",
- "type": "PHYSICAL",
- "updatedAt": "2016-06-16T06:20:11.116Z",
- "vlanRange": [
- {
- "from": 3600,
- "to": 3699
}
]
}
OK
Unauthorized
Not Found
{- "crossConnectConnectorType": "SC",
- "crossConnectId": "19204",
- "crossConnectMediaConvertor": true,
- "crossConnectMediaType": "SMF",
- "crossConnectProvider": "My cross connect provider",
- "crossConnectSalesRecordId": "",
- "id": "12345",
- "localLoopPartnerLocalLineNo": "L93850",
- "localLoopRemoteCarrierContactNo": "+61 3 2223 3344",
- "localLoopRemoteLocalLineNo": "L843840384",
- "localLoopRemoteLocalLinePartner": "Partner name",
- "localLoopRemoteRefNo": "#980344933948",
- "localLoopSpeed": "0",
- "managedRouterServiceCeWanInterface": "",
- "managedRouterServiceCeWanIpAddress": "",
- "managedRouterServiceCpeOrder": "",
- "managedRouterServiceDialupNo": "",
- "managedRouterServiceManagementIp": "192.0.2.101",
- "managedRouterServiceRemark": "",
- "managedRouterServiceRouterName": "cds-e038kf-jhsnv",
- "managedRouterServiceRouterOwner": "",
- "managedRouterServiceRouterProvider": "",
- "premiumColocationPanelNumber": "",
- "premiumColocationRackId": "",
- "premiumColocationSalesRecordId": ""
}
{- "activeChangedAt": "2016-06-16T06:20:10.640Z",
- "asn": {
- "asn": "176251",
- "createdAt": "2016-06-16T06:20:11.053Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "ALLOCATED",
- "updatedAt": "2016-06-16T06:20:11.053Z"
}, - "capacity": {
- "remaining": 900,
- "total": 1000,
- "utilised": 100
}, - "company": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [ ],
- "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2016-06-16T06:20:09.604Z",
- "deleted": false,
- "deletedAt": null,
- "groups": null,
- "headline": null,
- "id": "5762451982894b9b1b1a5dbc",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "corp",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 1,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "COMPANY",
- "updatedAt": "2016-06-16T06:20:09.604Z",
- "username": "corp",
- "verified": false
}, - "companyId": "5762451982894b9b1b1a5dbc",
- "connections": [
- {
- "id": "5762451d82894b9b1b1a5dd2",
- "name": "Sierra",
- "status": "ACTIVE"
}
], - "controllers": [
- {
- "activeChangedAt": "2016-06-16T06:20:11.458Z",
- "asn": {
- "asn": "54321",
- "createdAt": "2016-06-16T06:20:11.460Z",
- "deleted": false,
- "deletedAt": null,
- "status": "VERIFIED",
- "type": "SYSTEM",
- "updatedAt": "2016-06-16T06:20:11.460Z"
}, - "createdAt": "2016-06-16T06:20:11.114Z",
- "deleted": false,
- "deletedAt": null,
- "id": "5762451b82894b9b1b1a5dc6",
- "ip": {
- "ipv4": "198.51.100.1",
- "ipv6": "2001:DB8::1111:1111:1111:1111"
}, - "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "corp - Skyla",
- "password": "",
- "portIds": [
- "5762451a82894b9b1b1a5dc2"
], - "status": "ACTIVE",
- "type": "USER",
- "updatedAt": "2016-06-16T06:20:11.462Z",
- "vlan": 200
}
], - "createdAt": "2016-06-16T06:20:10.029Z",
- "dataCenterFacility": {
- "tags": [ ],
- "avatar": null,
- "avatarId": null,
- "background": null,
- "companies": null,
- "company": {
- "address": null,
- "addresses": [
- {
- "address": "11 Great Oaks Boulevard",
- "city": "San Jose",
- "country": "USA",
- "email": "",
- "geo": {
- "coordinates": [
- -121.78322,
- 37.24162
], - "type": "Point"
}, - "phone": "",
- "primary": true,
- "state": "California",
- "zip": "95119-1242"
}
], - "businessType": null,
- "city": null,
- "clientId": null,
- "companySize": null,
- "country": null,
- "dateFounded": null,
- "email": null,
- "emailDomains": [ ],
- "fax": null,
- "first": null,
- "industry": null,
- "last": null,
- "markets": { },
- "phone": null,
- "regionalInternetRegistry": null,
- "state": null,
- "website": null,
- "zip": null
}, - "createdAt": "2015-11-04T06:07:12.785Z",
- "dataCenterFacility": {
- "id": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metroId": "1232413986c08c061dd8c45f",
- "ready": true,
- "speeds": [ ]
}, - "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "groups": null,
- "headline": null,
- "id": "5126c9f1111e15a24a066130",
- "isSupport": false,
- "isSynced": null,
- "location": null,
- "name": "Equinix - SV1",
- "online": false,
- "phone": null,
- "social": null,
- "stats": {
- "articles": 0,
- "events": 0,
- "followers": 0,
- "following": 0,
- "interconnections": 0,
- "members": 0,
- "posts": 0,
- "privateArticles": 0,
- "privateEvents": 0,
- "privatePosts": 0
}, - "status": "ACTIVE",
- "summary": null,
- "type": "DATA_CENTER_FACILITY",
- "updatedAt": "2015-11-04T06:07:13.430Z",
- "username": "equinix-sv1",
- "verified": true
}, - "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z",
- "id": "5762451a82894b9b1b1a5dc2",
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "metro": {
- "code": null,
- "country": "USA",
- "createdAt": "2016-02-12T09:01:33.840Z",
- "deleted": false,
- "deletedAt": null,
- "description": null,
- "id": "1232413986c08c061dd8c45f",
- "logo": null,
- "name": "SJC",
- "ready": true,
- "regionIds": [ ],
- "updatedAt": "2016-02-12T09:01:33.840Z"
}, - "metroId": "1232413986c08c061dd8c45f",
- "name": "Vicente",
- "networkServiceProviderId": null,
- "partner": {
- "regionNames": [ ],
- "type": "NONE"
}, - "portId": null,
- "singleService": false,
- "speed": {
- "name": "1000 Mbps",
- "value": 1000
}, - "status": "ACTIVE",
- "type": "PHYSICAL",
- "updatedAt": "2016-06-16T06:20:11.116Z",
- "vlanRange": [
- {
- "from": 3600,
- "to": 3699
}
]
}
Obtain utilization information about a specific port using a specific time period and preferred resolution.
Utilization is based on connections attached to a port. Incoming connections (connections initiated by someone else that you accepted) are not included in utilization, but outgoing connections (connections you initiated) are included. You may not create an outgoing connection request that exceeds your port utilization.
OK
{- "portId": 120391239323,
- "results": [
- {
- "rxAverage": 1,
- "rxMax": 2,
- "rxMin": 0.005,
- "time": 49303945838,
- "txAverage": 1,
- "txMax": 2,
- "txMin": 0.005
}
], - "unit": "Mbps"
}
Return the vlan information around the given port
OK
{- "id": 120391239323,
- "available": [
- 100,
- 200,
- 300,
- 400
], - "ranges": [
- {
- "start": 100
}, - {
- "end": 1000
}
], - "unit": "Mbps"
}
DCP Partner | Username |
---|---|
AWS | amazon |
AZURE | azure |
GCE | google_cloud |
TENCENT | tencent-cloud |
ALICLOUD | alibaba_cloud |
OK
{- "id": "579ec72fa21a602e46f32c30",
- "companyId": "579ec72da21a602e46f32c29",
- "deviceId": "e8d1ab56-74ff-401a-8379-760a018178c1",
- "portId": null,
- "name": null,
- "speed": 1000,
- "locationId": "b3f5ac21-fec1-4418-9e1a-709d48da59fa",
- "dataCenterFacilityId": "5126c9f1111e15a24a066130",
- "networkServiceProviderId": null,
- "metroId": "d466b388d3e9ee0a92177910",
- "status": "ACTIVE",
- "type": "DCP",
- "partner": {
- "type": "AWS",
- "regionName": "us-west-1",
- "connectionSpeeds": [
- {
- "value": 50,
- "type": "AUTOMATIC"
}, - {
- "value": 100,
- "type": "AUTOMATIC"
}, - {
- "value": 200,
- "type": "AUTOMATIC"
}, - {
- "value": 300,
- "type": "AUTOMATIC"
}, - {
- "value": 400,
- "type": "AUTOMATIC"
}, - {
- "value": 500,
- "type": "AUTOMATIC"
}, - {
- "value": 1000,
- "type": "MANUAL"
}, - {
- "value": 10000,
- "type": "MANUAL"
}
]
}, - "asnId": null,
- "ip": {
- "ipv4": null,
- "ipv6": null
}, - "activeChangedAt": null,
- "updatedAt": "2016-08-01T03:51:11.554Z",
- "createdAt": "2016-08-01T03:51:11.554Z",
- "deleted": false,
- "deletedAt": "1970-01-01T00:00:00.000Z"
}
{- "results": [
- {
- "createdAt": "2016-08-23T05:48:34.022Z",
- "updatedAt": "2016-08-23T05:48:34.022Z",
- "value": 1000,
- "entitlementType": null,
- "destCompanyId": "57bbe3b04ae42f987d9668de",
- "destPortId": "57bbe3b04ae42f987d9668df",
- "floorMonthly": 0,
- "monthly": 0,
- "currency": "USD",
- "companyIds": [ ],
- "visible": false,
- "regionIds": [ ],
- "tags": [ ],
- "displayOrder": 0,
- "displayTemplate": "Unnamed",
- "name": "Global Connection",
- "id": "57bbe3b20e4a257d986b2d74"
}
]
}
{- "type": "LAYER2",
- "name": "string",
- "srcPortId": "string",
- "speed": {
- "name": "10000 Mbps",
- "value": 10000
}, - "destMetroId": "string",
- "destCompany": "string",
- "destPortId": "string",
- "paymentType": "creditcard",
- "partner": {
- "destPortIds": [
- "string"
], - "account": "string"
}
}
Check the capabilities of a Port.
OK
{- "capabilities": {
- "giaStandardV1": true,
- "l2TypeA": false,
- "l3vpnTypeA": true,
- "qinq": true
}
}