Console Connect logo

Port Orders

Create a port order/reservation

A port order is created in a 'dataCenterFacility'.

Please take note about the different LOA lead times for On-net & Extended (Off-net) data centers.

On-net: 24 hours.
Extended: Around 4 to 6 weeks.

Port Order Status Flow

  1. created - The initial status when this operation is called.
  2. processing - Reserving a port / the system will select the next available port.
  3. allocated - The status once the port is successfully ordered, during this status the cross connect will be installed by the Data Centner.
  4. loa_sent - (Optional) The status once the LOA was uploaded to the port and the customer can install the Cross Connect.
  5. setup_xc - (Optional) Setup Cross Connect.
  6. done - The status once the order has been completed and the order is moved to a port.

Note: The 'creditcard' payment type is only supported via the Console Connect web application. When using this payment type, you must also include 'paymentTransactionId' property in the request body.

Securityapi-key
Request
path Parameters
companyName
required
string

Username of the data center facility.

Example: supernetpa4
Request Body schema: application/json
paymentType
required
string

The payment method used.

Enum: "plan" "creditcard" "invoice"
billingId
string

The ID of the plan subscription. Only required when paymentType is 'plan'.

paymentTransactionId
string

The ID of the payment transaction. Only required when paymentType is 'creditcard'.

dataCenterFacility
required
string

The username of the data center facility.

speed
required
string

The port speed in Mbps, e.g., 1000 = 1Gbps. 10000 = 10Gbps. Must be >= 100.

portName
required
string

The name of the port

durationUnit
required
string
Default: "y"

Set to m if the Data Center accepts month-to-month port orders.

Enum: "m" "y"
bundleCrossConnect
boolean

Set to true to have the Cross Connect add-on with your port if your Data Center supports this. Only available in a 12 month contract.

discountCode
string

Apply promotion or partner code.

Responses
200

OK

400

Error

put/api/company/{companyName}/ports/orders
Request samples
application/json
{
  • "dataCenterFacility": "demodatacenter",
  • "speed": 1000,
  • "portName": "Demo Port",
  • "paymentType": "invoice",
  • "durationUnit": "y"
}
Response samples
application/json
{
  • "id": "66e28efa04a4727d5387da09",
  • "portName": "Demo Port",
  • "speed": {
    },
  • "paymentType": "invoice",
  • "discountId": null,
  • "billingId": "66e28efa04a4727d5387da06",
  • "externalId": null,
  • "salesRecordId": null,
  • "paymentTransactionId": null,
  • "payg": true,
  • "status": "created",
  • "loaStatus": "TODO",
  • "isEdgePort": false,
  • "cancelled": false,
  • "edgePayload": null,
  • "requestSource": "CONSOLE_API",
  • "createdBy": "",
  • "tags": [ ],
  • "type": "PHYSICAL",
  • "isManualCreate": false,
  • "dataCenterFacilityId": "5a94a7e2091e410012cdf0b4",
  • "metroId": "21ab4746f3ba6c3462def3e8",
  • "companyId": "5d4d056242fbd3000ab4c01d",
  • "crossConnectId": null,
  • "deleted": false,
  • "deletedAt": null,
  • "createdAt": "2024-09-12T06:49:30.052Z",
  • "updatedAt": "2024-09-12T06:49:30.354Z",
  • "durationUnit": "y",
  • "dataCenterFacility": {
    },
  • "metro": {
    },
  • "capabilities": { }
}

Get all order details

Get all port orders of a company

Important Notes:

  • This is where you can find all the port orders you have created.
  • You can also find the createdPortId here which you can use to query for a port by its order ID. See Read port details API and use the createdPortId in {portId} path parameter
Securityapi-key
Request
path Parameters
companyName
required
string

The username of the company that the order is for. You can find your companyName by querying Auth API under companies and look for username.

Example: samplecompanyname
Responses
200

OK

get/api/company/{companyName}/ports/orders
Response samples
application/json
{
  • "results": [
    ]
}

Get order details by ID

Get the details of a companies port order

Securityapi-key
Request
path Parameters
companyName
required
string

The username of the company that the order is for.

Example: Acme
orderId
required
string

The ID of the order.

Example: 56d691309a90128d55831db1
Responses
200

OK

get/api/company/{companyName}/ports/orders/{orderId}
Response samples
application/json
{
  • "billingId": "56d691309a90128d55831db2",
  • "cancelled": false,
  • "cancelledAt": "1970-01-01T00:00:00.000Z",
  • "cancelledBy": null,
  • "company": {
    },
  • "controller": {
    },
  • "createdAt": "2016-03-02T07:07:28.195Z",
  • "createdBy": "stan",
  • "deleted": false,
  • "deletedAt": "1970-01-01T00:00:00.000Z",
  • "deletedBy": null,
  • "id": "56d691309a90128d55831db1",
  • "locationId": null,
  • "crossConnectId": null,
  • "message": null,
  • "metro": {
    },
  • "port": {
    },
  • "portName": "PORT_1",
  • "speed": {
    },
  • "status": "created",
  • "updatedAt": "2016-03-02T07:07:28.195Z",
  • "updatedBy": null
}

Perform LOA action on a port order

A Letter of Authorisation is required as part of the process to connect to a port.

  • sendloa: Resends the LOA to the user.
  • loasent: Updates port order status to 'loa_sent'.
    • Note: loasent will fail with 409 unless port order status is 'ALLOCATED'.
Securityapi-key
Request
path Parameters
companyName
required
string

The username of the company to take the port order action for.

Example: Acme
orderId
required
string

The port order id you wish to take the LOA action for.

Example: 56d691301a1a128d55831db2
action
required
string

The LOA action to implement on the port order.

Examples:
sendloa
loasent
Responses
200

OK

post/api/company/{companyName}/ports/orders/{orderId}/{action}(sendloa|loasent)
Response samples
application/json
{
  • "billingId": "56d691309a90128d55831db2",
  • "cancelled": false,
  • "cancelledAt": "1970-01-01T00:00:00.000Z",
  • "cancelledBy": null,
  • "company": {
    },
  • "controller": {
    },
  • "createdAt": "2016-03-02T07:07:28.195Z",
  • "createdBy": "stan",
  • "deleted": false,
  • "deletedAt": "1970-01-01T00:00:00.000Z",
  • "deletedBy": null,
  • "id": "56d691309a90128d55831db1",
  • "locationId": null,
  • "crossConnectId": null,
  • "message": null,
  • "metro": {
    },
  • "port": {
    },
  • "portName": "PORT_1",
  • "speed": {
    },
  • "status": "created",
  • "updatedAt": "2016-03-02T07:07:28.195Z",
  • "updatedBy": null
}
➔ Next to Ports