Create a new service

Order and provision a new service on one or more of your CloudLX ports.

Request

Endpoint: /api/services/create
Method: POST
Headers: Accept: application/vnd.cloudlx.v1+json
Content-type: application/json
Authorization: Bearer <access_token>

Example Request:

                                
    {
      "port_id": "209",
      "service_port_id": "1355",
      "product_id": "3507",
      "name": "My AWS Service",
      "vlan": "325"
    }
                                
                            

Request Values - Required

name Description The friendly name for the service
Type Text
Example My AWS Service
port_id Description The CloudLX port_id which can be retrieved from the available ports API endpoint. Port must be of service_type "INT"
Type Integer
Example 209
service_port_id Description The CloudLX port_id which can be retrieved from the available ports API endpoint Port must not be of service_type "INT".
NOTE: This can be replaced with far_end_port in the Inter-port specific documentation below.
Type Integer
Example 209
product_id Description The product_id for the type of service being ordered which can be looked up from the service pricing endpoint
Type Integer
Example 3507
vlan Description The CVLAN to be used on the service, between 1 and 4098. Get valid VLAN values using the Check available VLANs between two ports API endpoint.
NOTE: This value is NOT required for Inter-port Services unless otherwise specified in the Inter-port Service documentation.
Type Integer
Example 325

Request Values - Optional

disable_auto_renew Description Disable the auto renew functionality on the service, it will expire at the end of the period
Type Boolean
Example true

Request Values - Service type specific

Inter-port Service

Example Request:

                                
    {
        "port_id": 1345,
        "far_end_port_id": 1014,
        "cost_id": 15411,
        "name": "My First Service",
        "vlan": 4
    }
                                
                            
far_end_port_id Description The CloudLX port_id which can be retrieved from the available ports API endpoint. Port must be of service_type "INT"
Type Integer
Example 210
cvlan_mapping_type Description The CVLAN mapping type. Options; bundled|range|translation|virtual-untagged|epline
Type enum (string)
Example "bundled"

cvlan_mapping_type: bundled

vlans Description The list of VLANs
Type Array(Integer)
Example [ 1, 12, 54 ]

cvlan_mappin_type: range

vlan_from Description The first VLAN
Type Integer
Example 14
vlan_to Description The last VLAN
Type Integer
Example 22

cvlan_mapping_type: translation

vlan Description The pre-translated value of the VLAN
Type Integer
Example 32
translated_vlan Description The post-translated value of the VLAN
Type Integer
Example 32

cvlan_mapping_type: virtual-untagged

untagged_port_id Description The ID of the untagged port
Type Integer
Example 1261

Amazon Web Services

aws_account Description The AWS account ID to connect the service to
Type Text
Example 0123456789012

Microsoft Azure

msa_service_key Description The Azure service key created for this service
Type Text
Example 4a042306-0846-4ca2-b5bb-8689b5412739
secondary_port_id Description The secondary port_id to use for the backup service
Type Integer
Example 211
translated_vlan Description The translated VLAN of the port when the same port is used for port_id and secondary_port_id
Type Integer
Example 32

Microsoft Azure ExpressRoute

msa_service_key Description The Azure ExpressRoute service key created for this service
Type Text
Example 4a042306-0846-4ca2-b5bb-8689b5412739
secondary_port_id Description The secondary port_id to use for the backup service
Type Integer
Example 211
vlan_office Description The Office 365 VLAN
Type Integer
Example 33
vlan_public Description The public peering VLAN
Type Integer
Example 34
vlan_private Description The private peering VLAN
Type Integer
Example 35

Google Cloud Compute

gcp_project_id Description Your unique project identifier within Google Cloud
Type Text
Example myservice
host_ip Description Description Public IP address for the hosts. Needs to be a Public /24 address range
Type Text
Example 1.1.1.1/24
link_ip Description Public IP addresses for the link. IP address range with subnet mask 255.255.255.254 used for the link only
Type Text
Example 1.1.1.1/32
asn Description Your public ASN number
Type Text
Example AS12345
md5_session_key Description The md5 session key for the connection
Type Text
Example 01cd2d699991ea786acf871aa39646dd
contact_name Description A technical contact for the connection
Type Text
Example Joe Bloggs
contact_email Description An email address for the technical contact
Type Text
Example joebloggs@mydomain.com
contact_phone Description A telephone number for the technical contact
Type Text
Example +44123456485

Alibaba Cloud

ali_account Description The Alibaba Cloud account ID to connect the service to
Type Text
Example 1234567890

Oracle Cloud

ocid Description The Oracle Cloud ID to connect the service to
Type Text
Example ocid.virtualcircuit.oc1.abcd1234efgh5678

Internet Exchange

asn Description Your public ASN number
Type Integer
Example 44356
contact_email Description An email address for the technical contact
Type Text
Example joebloggs@yourdomain.com
contact_name Description A technical contact for the connection
Type Text
Example Joe Bloggs
contact_phone Description A telephone number for the technical contact
Type Text
Example 44123456485
noc_email Description An email address for the NOC contact
Type Text
Example noc@yourdomain.com
peering_contact_email Description An email address for the peering contact
Type Text
Example peering@yourdomain.com
router_name Description Host name of the router
Type Text
Example border.domain.com
as_macro Description The AS Macro to use for the service
Type Text
Example AS-MACRO
macro_rir Description The Macro RIR to use for the service
Type Text
Example RIPE

Internet Exchange: NL-IX

as_number Description Your public ASN number
Type Integer
Example 44356
contact_first_name Description The first name of the technical contact for the connection
Type Text
Example Joe
contact_last_name Description The last name of the technical contact for the connection
Type Text
Example Bloggs
contact_email Description An email address for the technical contact
Type Text
Example joebloggs@mydomain.com

Response:

On a successful service creation, the API will respond with a 201 Created response.

                                
    {
        "message": "Service created successfully",
        "service_id": 123
    }
                                
                            
message Description The successfully created response message
Type Text
Example Service created successfully
service_id Description The service_id for the newly created service
Type Integer
Example 123

Back to top