1. Ports
  3. API Documentation
  4. Purchase Port

Purchase a port

Purchase a new port in Infiny.

Request

Endpoint: /api/ports/purchase
Method: POST
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Example Request:

                                
    {
        "port_id": 1066,
        "order_datacentre_id": 176,
        "name": "My first port",
        "term": {
            "name": "Month",
            "amount": 1
        },
        "supplier_to_cable": true,
        "network_type": "uni"
    }

Request Values - Required

port_id Description The ID of the port
Type Integer
Example 1066
name Description The name of the port
Type String
Example My first port
term Description The term for the port pricing
Type Object
Example See example above, referenced from the available ports API
supplier_to_cable Description Optional, defaulting to false. Whether cabling should be performed by supplier or not.
Type Boolean
Example true

Request Values - Optional

order_datacentre_id Description The ID of the datacentre. This should be provided if the port details indicated that it was cross-connected ("cross_connected": true) in the Available ports endpoint.
Type Integer
Example 176
network_type Description Value determine the ports network type, either UNI or ENNI. If not provide, UNI will be assumed.
Type Enum(String) [uni|enni]
Example uni

Response

Example:

                                
    {
        "success": true,
        "message": "1 port ordered successfully"
    }

Back to top