CloudRouter

CloudRouter / L3VPN operations.

Provision a new CloudRouter

Prerequisites

  • The authenticated user account has L3VPN Create permissions
Request
path Parameters
companyId
required
string

The ID of the company.

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

Name of the VPN

Responses
200

OK

post/app-user/{companyId}/l3vpns
Request samples
application/json
{
  • "name": "My CloudRouter"
}
Response samples
application/json
{
  • "id": "6259d021-664e-4bb0-942a-b1cd68a7a75b",
  • "companyId": "5ea242303962644b52fc4346",
  • "name": "My CloudRouter",
  • "status": "CREATING",
  • "deleted_at": null,
  • "created_at": "2021-06-20T23:19:01.364Z",
  • "updated_at": "2021-06-20T23:19:01.364Z"
}

Query existing L3VPNs

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
[
  • {
    }
]

Deprovision a new CloudRouter

Prerequisites:

  • The authenticated user account has L3VPN Destroy permissions.

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

  • The L3VPN is in the status: CREATED.

Request
path Parameters
companyId
required
string

The ID of the company.

Example: 5e4cb418ab1dbe8c8476163b
l3vpnId
required
string

The ID of the Layer 3 VPN

Example: 61668e06e8dd60b034f3cd61
Responses
200

OK

delete/app-user/{companyId}/l3vpns/{l3vpnId}
Response samples
application/json
{
  • "id": "6259d021-664e-4bb0-942a-b1cd68a7a75b",
  • "companyId": "5ea242303962644b52fc4346",
  • "name": "My CloudRouter",
  • "status": "DELETING",
  • "deleted_at": null,
  • "created_at": "2021-06-20T23:19:01.364Z",
  • "updated_at": "2021-06-20T23:19:01.364Z"
}

Provision a new Google Layer 3 VPN Site on an existing VPN

Provision a new Google Layer 3 VPN site

Prerequisites:

  • Your company has been verified on the Console Connect platform.
  • The authenticated user account has L3VPN Site Create permissions.
  • Your company already has a VPN on the Console Connect platform.

Notes

  • The DCP port (identified with portId) must have enough remaining capacity.
  • Currently, the only supported classOfService is 100% bronze: [{name: "bronze", value: 100}]

Peer-specific validation: GOOGLE

  • peer.asn will default to 16550. Must be 16550 if provided.
  • peer.data.pairingKey must be provided.
  • peer.data.tierRateLimit must be one of the speed tiers marked as available on the DCP port.
  • peer.data.tierRateLimit must be greater than or equal to the requested accessCircuit.rateLimit
Request
path Parameters
companyId
required
string

The ID of the company.

Example: 5e4cb418ab1dbe8c8476163b
vpnId
required
string

The ID of an ACTIVE VPN.

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

L2 config

name
required
string

Name of the VPN site.

required
object

L3 peer config

Responses
200

OK

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

Get list of L3VPN sites

Request
path Parameters
companyId
required
string

The ID of the company.

Example: 5e4cb418ab1dbe8c8476163b
vpnId
required
string

The ID of an ACTIVE VPN.

Example: 5e4cb418ab1dbe8c8476163b
Responses
200

OK

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