CrossConnect

Cross connect service endpoints

Get the list of all cross connect

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/crossConnect

HTTPcURLJavaScriptPython

GET /v3/crossConnect HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "paymentTerm": 1,
    "purchaseOrder": "text",
    "monthlyFee": "text",
    "setupFee": "text",
    "currencyId": 1,
    "colocatedServerId": 1,
    "hostId": 1,
    "locationIdSideA": 1,
    "locationIdSideAName": "text",
    "locationIdSideZ": 1,
    "locationIdSideZName": "text",
    "locationDetails": "text",
    "rackIdSideA": 1,
    "rackIdSideAName": "text",
    "rackIdSideZ": 1,
    "rackIdSideZName": "text",
    "goLiveDate": "text",
    "internalId": "text",
    "patchInternalName": "text",
    "patchCustomerName": "text",
    "thirdPartyId": "text",
    "vendorId": 1,
    "cableType": 1,
    "cableSpeed": 1,
    "connectorSideAType": 1,
    "connectorSideZType": 1,
    "diverseFromPatchId": 1,
    "customerNotes": "text",
    "uplinks": [
      {
        "side": "text",
        "uplinkId": 1
      }
    ],
    "connectivityType": "text",
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "bandwidthBillingType": 1
  }
]

Get the list of all cross connect

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

The ID of the cross connect

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

403

Invalid credentials

404

Invalid cross connect ID

500

Internal Server Error

application/json

get

/v3/crossConnect/{crossConnectId}

HTTPcURLJavaScriptPython

GET /v3/crossConnect/{crossConnectId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "paymentTerm": 1,
    "purchaseOrder": "text",
    "monthlyFee": "text",
    "setupFee": "text",
    "currencyId": 1,
    "colocatedServerId": 1,
    "hostId": 1,
    "locationIdSideA": 1,
    "locationIdSideAName": "text",
    "locationIdSideZ": 1,
    "locationIdSideZName": "text",
    "locationDetails": "text",
    "rackIdSideA": 1,
    "rackIdSideAName": "text",
    "rackIdSideZ": 1,
    "rackIdSideZName": "text",
    "goLiveDate": "text",
    "internalId": "text",
    "patchInternalName": "text",
    "patchCustomerName": "text",
    "thirdPartyId": "text",
    "vendorId": 1,
    "cableType": 1,
    "cableSpeed": 1,
    "connectorSideAType": 1,
    "connectorSideZType": 1,
    "diverseFromPatchId": 1,
    "customerNotes": "text",
    "uplinks": [
      {
        "side": "text",
        "uplinkId": 1
      }
    ],
    "connectivityType": "text",
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "bandwidthBillingType": 1
  }
]

Update the cross connect by ID

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

Body

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

403

Invalid credentials

404

Invalid crossConnectId

500

Internal Server Error

application/json

put

/v3/crossConnect/{crossConnectId}

HTTPcURLJavaScriptPython

PUT /v3/crossConnect/{crossConnectId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "purchaseOrder": "text",
  "patchCustomerName": "text"
}

[
  {
    "id": 1,
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "paymentTerm": 1,
    "purchaseOrder": "text",
    "monthlyFee": "text",
    "setupFee": "text",
    "currencyId": 1,
    "colocatedServerId": 1,
    "hostId": 1,
    "locationIdSideA": 1,
    "locationIdSideAName": "text",
    "locationIdSideZ": 1,
    "locationIdSideZName": "text",
    "locationDetails": "text",
    "rackIdSideA": 1,
    "rackIdSideAName": "text",
    "rackIdSideZ": 1,
    "rackIdSideZName": "text",
    "goLiveDate": "text",
    "internalId": "text",
    "patchInternalName": "text",
    "patchCustomerName": "text",
    "thirdPartyId": "text",
    "vendorId": 1,
    "cableType": 1,
    "cableSpeed": 1,
    "connectorSideAType": 1,
    "connectorSideZType": 1,
    "diverseFromPatchId": 1,
    "customerNotes": "text",
    "uplinks": [
      {
        "side": "text",
        "uplinkId": 1
      }
    ],
    "connectivityType": "text",
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "bandwidthBillingType": 1
  }
]

Get all the invoices for a specific cross connect

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

The ID of the cross connect

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

403

Invalid credentials

404

Invalid cross connect ID

500

Internal Server Error

application/json

get

/v3/crossConnect/{crossConnectId}/invoice

HTTPcURLJavaScriptPython

GET /v3/crossConnect/{crossConnectId}/invoice HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "paymentTerm": 1,
    "purchaseOrder": "text",
    "monthlyFee": "text",
    "setupFee": "text",
    "currencyId": 1,
    "colocatedServerId": 1,
    "hostId": 1,
    "locationIdSideA": 1,
    "locationIdSideAName": "text",
    "locationIdSideZ": 1,
    "locationIdSideZName": "text",
    "locationDetails": "text",
    "rackIdSideA": 1,
    "rackIdSideAName": "text",
    "rackIdSideZ": 1,
    "rackIdSideZName": "text",
    "goLiveDate": "text",
    "internalId": "text",
    "patchInternalName": "text",
    "patchCustomerName": "text",
    "thirdPartyId": "text",
    "vendorId": 1,
    "cableType": 1,
    "cableSpeed": 1,
    "connectorSideAType": 1,
    "connectorSideZType": 1,
    "diverseFromPatchId": 1,
    "customerNotes": "text",
    "uplinks": [
      {
        "side": "text",
        "uplinkId": 1
      }
    ],
    "connectivityType": "text",
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "bandwidthBillingType": 1
  }
]

cancel the cross connect by ID

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

Body

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

Responses

204

No Content

403

Invalid credentials

404

Invalid crossConnectId

422

unprocessable entity

500

Internal Server Error

application/json

put

/v3/crossConnect/{crossConnectId}/cancel

HTTPcURLJavaScriptPython

PUT /v3/crossConnect/{crossConnectId}/cancel HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "purchaseOrder": "text",
  "patchCustomerName": "text"
}

No content

Revert the cancellation of a cross connect by ID

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

Body

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Cross connect ID

dateStartstringRead-onlyRequired

Start date of the cross connect

dateEndstringRead-onlyRequired

End date of the cross connect

dateCancelledstringRead-onlyRequired

Cancelled date of the cross connect

dateEndContractstringRead-onlyRequired

End contract date of the cross connect

contractPeriodinteger · integerRead-onlyRequired

Contract period of the cross connect

extendPeriodinteger · integerRead-onlyRequired

Extend period of the cross connect

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

paymentTerminteger · integerRead-onlyRequired

Payment term of the cross connect

purchaseOrderstringOptional

Purchase order of the cross connect

monthlyFeestringRead-onlyRequired

Monthly fee of the cross connect in cents

setupFeestringRead-onlyRequired

Setup fee of the cross connect in cents

currencyIdinteger · integerRead-onlyRequired

The currency ID

• 0: EURO
• 1: USD
• 9: YEN

colocatedServerIdinteger · integerRead-onlyRequired

Colocated server ID

hostIdinteger · integerRead-onlyRequired

Host ID

locationIdSideAinteger · integerRead-onlyRequired

Location ID of the Side A

locationIdSideANamestringRead-onlyRequired

Location name of the Side A

locationIdSideZinteger · integerRead-onlyRequired

Location ID of the Side B

locationIdSideZNamestringRead-onlyRequired

Location name of the Side B

locationDetailsstringRead-onlyRequired

Location details

rackIdSideAinteger · integerRead-onlyRequired

Rack ID of the Side A

rackIdSideANamestringRead-onlyRequired

Rack Name of the Side A

rackIdSideZinteger · integerRead-onlyRequired

Rack ID of the Side B

rackIdSideZNamestringRead-onlyRequired

Rack Name of the Side B

goLiveDatestringRead-onlyRequired

Go live date

internalIdstringRead-onlyRequired

Internal ID of the service

patchInternalNamestringRead-onlyRequired

Internal name of the patch

patchCustomerNamestringOptional

Customer name of the patch

thirdPartyIdstringRead-onlyRequired

Third party ID of the service

vendorIdinteger · integerRead-onlyRequired

Vendor ID of the service

cableTypeinteger · integerRead-onlyRequired

Type of cable

cableSpeedinteger · integerRead-onlyRequired

Cable speed

connectorSideATypeinteger · integerRead-onlyRequired

Connector of Side A

connectorSideZTypeinteger · integerRead-onlyRequired

Connector of Side Z

diverseFromPatchIdinteger · integerRead-onlyRequired

Diverse from patch id

customerNotesstringRead-onlyRequired

Notes of the customer

connectivityTypestringRead-onlyRequired

The type of connectivity service Following will be possible values:

• Connectivity: Transport
• Connectivity: IP connectivity
• Connectivity: Crossconnect

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

• 1: unmetered connection
• 2: measured in TB per month
• 3: measured in mbit 95th percentile

403

Invalid credentials

404

Invalid crossConnectId

422

unprocessable entity

500

Internal Server Error

application/json

put

/v3/crossConnect/{crossConnectId}/cancel/revert

HTTPcURLJavaScriptPython

PUT /v3/crossConnect/{crossConnectId}/cancel/revert HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "purchaseOrder": "text",
  "patchCustomerName": "text"
}

[
  {
    "id": 1,
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "paymentTerm": 1,
    "purchaseOrder": "text",
    "monthlyFee": "text",
    "setupFee": "text",
    "currencyId": 1,
    "colocatedServerId": 1,
    "hostId": 1,
    "locationIdSideA": 1,
    "locationIdSideAName": "text",
    "locationIdSideZ": 1,
    "locationIdSideZName": "text",
    "locationDetails": "text",
    "rackIdSideA": 1,
    "rackIdSideAName": "text",
    "rackIdSideZ": 1,
    "rackIdSideZName": "text",
    "goLiveDate": "text",
    "internalId": "text",
    "patchInternalName": "text",
    "patchCustomerName": "text",
    "thirdPartyId": "text",
    "vendorId": 1,
    "cableType": 1,
    "cableSpeed": 1,
    "connectorSideAType": 1,
    "connectorSideZType": 1,
    "diverseFromPatchId": 1,
    "customerNotes": "text",
    "uplinks": [
      {
        "side": "text",
        "uplinkId": 1
      }
    ],
    "connectivityType": "text",
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1,
    "bandwidthBillingType": 1
  }
]

Get the traffic usage graph (last year)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

ID of the cross connect to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid cross connect ID or uplink ID

500

Internal Server Error

application/json

get

/v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/year

HTTPcURLJavaScriptPython

GET /v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/year HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get the traffic usage graph (last 30 days)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

ID of the cross connect to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid cross connect ID or uplink ID

500

Internal Server Error

application/json

get

/v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/month

HTTPcURLJavaScriptPython

GET /v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/month HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get the traffic usage graph (last 7 days)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

ID of the cross connect to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid cross connect ID or uplink ID

500

Internal Server Error

application/json

get

/v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/week

HTTPcURLJavaScriptPython

GET /v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/week HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]

Get the traffic usage graph (last 24 hours)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

crossConnectIdintegerRequired

ID of the cross connect to fetch traffic for

upLinkIdintegerRequired

ID of the uplink to fetch traffic for

Responses

200

Base64 encoded image string

application/json

string[]Optional

403

Invalid credentials

404

Invalid cross connect ID or uplink ID

500

Internal Server Error

application/json

get

/v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/day

HTTPcURLJavaScriptPython

GET /v3/crossConnect/{crossConnectId}/network/usage/{upLinkId}/graph/day HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  "text"
]