Console Connect logo

CloudRouter

CloudRouter / L3VPN operations.

Provision a new CloudRouter

Prerequisites:

  • Obtain your company ID. You can call Search API (i.e. GET https://api.consoleconnect.com/api/search?page=1&count=20&type=companies&q={companyName}). See Search API for more details. Or you can get both companyName and companyId in Auth API
  • Use API key in the Authorization Bearer Token (see API Key)
  • The authenticated user account has L3VPN Create permissions.
    • The user account has the 'Network Admin'/'NETWORKCONTROL' role. This can be verified or assigned by a user who has 'Account Admin' or 'User Admin' permission via the user admin page in Console. You can check here.
Securityapi-key
Request
path Parameters
companyId
required
string

The id of the company

Example: 5ea242303962644b52fc4346
Request Body schema: application/json
required
name
required
string

Your CloudRouter name

paymentMethod
required
string

Payment Method

bandwidth
required
string

Total bandwidth of all sites you intend to attach to this CloudRouter

required
object

Minimum contract duration. Service will continue month-to-month after complete

discountCode
string
Responses
200

OK

post/app-user/{companyId}/l3vpns
Request samples
application/json
{
  • "name": "My CloudRouter",
  • "paymentMethod": "invoice",
  • "bandwidth": "500MB",
  • "duration": {
    }
}
Response samples
application/json
{
  • "name": "My CloudRouter",
  • "status": "CREATING",
  • "id": "63e48134c3af0500151b59f3",
  • "paymentMethod": "invoice",
  • "duration": {
    },
  • "bandwidth": "500MB",
  • "companyId": "5ea242303962644b52fc4346",
  • "deletedAt": null,
  • "createdAt": "2023-02-09T05:14:28.759Z",
  • "updatedAt": "2023-02-09T05:14:28.760Z"
}

Query existing CloudRouters

Securityapi-key
Request
path Parameters
companyId
required
string

The ID of the company

Example: 5e4cb418ab1dbe8c8476163b
Responses
200

OK

get/app-user/{companyId}/l3vpns
Response samples
application/json
[
  • {
    },
  • {
    }
]

Find Valid Cloud Providers

Get the list of cloud providers.

Securityapi-key
Request
query Parameters
filter
object

Should put a conditional value isCloudProvider to true to query the Valid Cloud Providers (see Example above)

Example: filter={"where":{"isCloudProvider":true}}
Responses
200

OK

401

Unauthorized

get/v2/companies
Response samples
application/json
[
  • {
    }
]

Find Valid Ports in a Cloud Provider

Get the list of valid ports for a specific cloud provider.

Note: If there are no connectionSpeeds listed under partner, this field will not be required on the create site payload.

Securityapi-key
Request
path Parameters
providerId
required
string

The ID of the Cloud Provider.

Example: 5aa7209defe3bc00124d075f
Responses
200

OK

401

Unauthorized

get/v2/companies/cloud-providers/{providerId}/ports
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Deprovision a CloudRouter

Prerequisites:

  • The authenticated user account has CloudRouter Destroy permissions.

  • The CloudRouter does not have any attached sites which have not been deleted.

  • The CloudRouter is in the status: CREATED.

  • The contract end date must be in the past

Securityapi-key
Request
path Parameters
companyId
required
string

The ID of the company.

Example: 5e4cb418ab1dbe8c8476163b
l3vpnId
required
string

The ID of the CloudRouter

Example: 61668e06e8dd60b034f3cd61
Responses
200

OK

400

The CloudRouter having active sites cannot be deleted / CloudRouter's contract is still active

404

The CloudRouter has not found

delete/app-user/{companyId}/l3vpns/{l3vpnId}
Response samples
application/json
{
  • "uuid": "4c5f6bcc-3d8b-4be7-a4a7-e44c711007d7",
  • "name": "My CloudRouter",
  • "status": "DELETING",
  • "id": "63e47974c3af0500151b59ef",
  • "companyId": "5d4d056242fbd3000ab4c01d",
  • "deletedAt": null,
  • "createdAt": "2022-01-09T04:41:24.455Z",
  • "updatedAt": "2023-02-15T03:34:16.916Z",
  • "paymentMethod": "invoice",
  • "duration": {
    },
  • "bandwidth": "500MB"
}

Provision a new Site on an existing VPN (CloudRouter)

Provision a new VPN site

Prerequisites:

  • Your company has been verified on the Console Connect platform and you have signed the Specific Terms for API use. Contact Support if you are unsure whether this has been completed for your company.
  • Use API key to authenticate Once you apply for an API key the Support team will send you the key that you will require. (See Auth)
  • The authenticated user account has L3VPN Update and L3VPN Site Create permissions.
  • Your company already has an L3VPN (CloudRouter) on the Console Connect platform. You can check this in the Web Application or use the Query existing CloudRouters APi endpoint (See Query existing CloudRouters)
  • Site Ports:
    • The port (identified with portId) must have enough remaining capacity.
    • The port needs to be Active.
  • Tier Rate Limit for DCP providers:
    • Must be one of the speed tiers marked as available on the DCP port.
    • Must be greater than or equal to the requested rateLimit.
  • My Port Site:
    • My port sites (peer.type "SELF") are sites created on one of your active Console Connect Ports.

Site Ports

The port (identified with portId) must have enough remaining capacity.

Tier Rate Limit for DCP providers

  • must be one of the speed tiers marked as available on the DCP port.
  • must be greater than or equal to the requested rateLimit

My Port Site

My port sites (peer.type "SELF") are sites created on one of your active Console Connect Ports.

Securityapi-key
Request
path Parameters
companyId
required
string

The ID of the company. You can check your companyId in your account on Console Connect website or you can query in Auth API

Example: 5e4cb418ab1dbe8c8476163b
vpnId
required
string

The ID of your CloudRouter. You can find this from the response of the create CloudRouter endpoint, or by querying CloudRouters (see Query existing CloudRouters)

Example: 5e4cb418ab1dbe8c8476163b
Request Body schema: application/json
required
One of:
required
object

L2 config

name
required
string

Name for the new VPN site.

required
object

L3 peer config

discountCode
string

A valid discount code.

Responses
200

OK

400

Validation errors

post/app-user/{companyId}/l3vpn/{vpnId}/site
Request samples
application/json
{
  • "accessCircuit": {
    },
  • "name": "my_cloudrouter_site_name",
  • "peer": {
    },
  • "discountCode": "CLOUDROUTER10"
}
Response samples
application/json
{
  • "service": {
    }
}

Get list of CloudRouter sites

Securityapi-key
Request
path Parameters
companyId
required
string

The ID of the company.

Example: 5d4d056242fbd3000ab4c01d
l3vpnId
required
string

The ID of an ACTIVE CloudRouter.

Example: 63e48134c3af0500151b59f3
Responses
200

OK

get/app-user/{companyId}/l3vpn/{l3vpnId}/sites
Response samples
application/json
[
  • {
    }
]

Deprovision a Site of an existing CloudRouter

Prerequisites:

  • The authenticated user account has permissions to delete the site of an existing CloudRouter.
Securityapi-key
Request
path Parameters
companyId
required
string

The ID of the company.

Example: 5e4cb418ab1dbe8c8476163b
l3vpnId
required
string

The ID of the CloudRouter

Example: 61668e06e8dd60b034f3cd61
siteId
required
string

The ID of site

Example: 61668e06e8dd60b034f3cd61
Responses
200

OK

401

Unauthorized

404

CloudRouter site record with specified id was not found

delete/app-user/{companyId}/l3vpns/{l3vpnId}/sites/{siteId}
➔ Next to Entitlements