Oracle FastConnect

Connection to Oracle FastConnect is currently the same as a Business to Business Layer 2 connection. You need to provision the service to the Oracle company on Console Connect then our Support team will receive your request and complete the provisioning on Console Connect for you. You will have to send your Oracle OCID to Support so that they can complete the provisioning in Oracle for you.

Choosing Your Source Port

Request

curl 'https://api.consoleconnect.com/api/company/:companyUsername/ports?deleted=false' \
--header 'Authorization: Bearer <API_KEY>' \

Make sure to replace :companyUsername with your actual company username and <API_KEY> with your API key.

Response

You might have multiple returned in the results but only choose one.

Take note of the id property since we will use this as the portId.

{
  "results": [
    {
      "id": "66c29b3c6dcad34e5b728c9c", // This property will be the portId of the request payload
      "name": "My-Port-1",
      "speed": {
        "value": 1000,
        "name": "1000 Mbps"
      },
      "tags": [],
      "dataCenterFacilityId": "5aa89b04ac86ba0012345bdf",
      "popId": "99759532-0aeb-4e02-a876-5b505e9b213a",
      "metroId": "77d9f1fbbcaa906f3cddb6d1",
      "companyId": "5d4d056242fbd3000ab4c01d",
      "status": "ACTIVE",
      "updatedAt": "2024-08-19T01:09:16.376Z",
      "createdAt": "2024-08-19T01:09:16.376Z",
      "deleted": false,
      "deletedAt": null,
      "paymentType": "invoice",
      "payg": true
      ...
    }
    ...
  ]
}

Finding Available Oracle NNI

Choose Destination Metro

Request

curl 'https://api.consoleconnect.com/api/company/oracle/metro/capabilities' \
--header 'Authorization: Bearer <API_KEY>' \

Make sure to replace <API_KEY> with your API key.

Response

You might have multiple returned in the results but only choose one and not the same as the source port.

Take note of the id property since we will use this as the destMetroId and firstDataCenterFacilityIdInMetro as the destDcf.

{
  "results": [
    {
      "name": "Hong Kong",
      "code": "HKG",
      "logo": null,
      "canCreateController": false,
      "tags": [],
      "description": "",
      "country": "hk",
      "rir": "APNIC",
      "regionIds": [
        "5c05cb06cad910000ae251f4"
      ],
      "ready": true,
      "id": "77d9f1fbbcaa906f3cddb6d1", // This property will be the destMetroId of the request payload
      "deletedAt": null,
      "createdAt": "2017-12-18T00:45:44.120Z",
      "updatedAt": "2024-02-25T05:02:47.267Z",
      "deleted": false,
      "capabilities": {
        "layer2": true
      },
      "firstDataCenterFacilityIdInMetro": "5aa89b04ac86ba0012345bdf" // This property will be the destDcf of the request payload
    }
  ]
}

Create a Layer 2 connection request

Create a Layer 2 connection request to a specified destination company. Layer 2 connections require a source port ID and requested metro.

  • You may not create an outgoing connection request that exceeds your port utilization or plan entitlement.
  • Both parties must approve a connection before it is activated. When either party makes a billing or capacity change, the other party must approve the connection using the approve endpoint.
  • The 'paymentType' can only be 'invoice'. A 'paymentType' of 'creditcard' is only supported via the Console Connect web application.
  • For pay-as-you-go connections where paymentType is 'creditcard', paymentTransactionId, duration and evergreen options must be provided in the request.
  • If paymentType is 'invoice', 'destDcf', 'duration' and 'durationUnit' should be provided.
Securityapi-key
Request
path Parameters
username
required
string

The username of the company creating the connection.

Example: acme
Request Body schema: application/json
required
type
required
string

The connection type, typically "LAYER_2".

Value: "LAYER2"
name
required
string

The name of the new connection.

portId
required
string

The source port ID.

destPortId
required
string
regionId
string
destRegionId
string
destDcf
string
speed
required
number

The port speed in Mbps.

destMetroId
required
string

The ID of the destination metro.

destCompany
required
string

The username of the destination company.

paymentType
required
string

The PAYG payment type.

Enum: "creditcard" "invoice"
duration
required
number
durationUnit
required
string

The duration unit for the connection ('d', 'w', 'm', 'y').

evergreen
boolean
classOfService
required
string
Enum: "GOLD" "SILVERPLUS" "SILVER" "BRONZE"
srcVlanRequest
number or null
destVlanRequest
number or null
discountCode
string
Responses
200

OK

put/api/v2/company/{username}/connections/layer2
Request samples
application/json
{
  • "type": "LAYER2",
  • "name": "my new connection",
  • "portId": "123",
  • "speed": 1000,
  • "paymentType": "invoice",
  • "duration": 1,
  • "durationUnit": "m",
  • "destPortId": "d466b388d3e9ee0a92177910",
  • "destCompany": "companyusername"
}
Response samples
application/json
{
  • "id": "58afc0499430ab7f3666b990",
  • "type": "LAYER2",
  • "status": "CREATING",
  • "srcRegionId": "236107000000000000000001",
  • "destRegionId": "236107000000000000000001",
  • "updatedAt": "2017-02-24T05:10:44.942Z",
  • "createdAt": "2017-02-24T05:10:33.807Z",
  • "speed": {
    },
  • "subconnections": [ ],
  • "vlan": {
    },
  • "name": "my new connection",
  • "cdrBillingType": "METRO",
  • "payg": true,
  • "billingType": [
    ],
  • "classOfService": "BRONZE"
}