---
title: "OVHcloud Connect - Configuration using the OVHcloud APIv6"
description: "NOTE: To ensure the correct operation of this service, you must be aware of the technical capabilities and limitations of the OVHcloud Connect solution and conf"
url: https://docs.us.ovhcloud.com/en/network/ovhcloud-connect/configuration-using-apiv6
lang: en
---
> For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt.

# OVHcloud Connect - Configuration using the OVHcloud APIv6

## Requirements

**Warning:**

**NOTE:** To ensure the correct operation of this service, you must be aware of the [technical capabilities and limitations of the OVHcloud Connect solution](https://docs.us.ovhcloud.com/en/network/ovhcloud-connect/technical-capabilities-limitations.md) and configure your network devices accordingly.

- An [OVHcloud Connect service](https://us.ovhcloud.com/network/ovhcloud-connect/)
- Access to the [OVHcloud APIv6](https://api.us.ovhcloud.com/console) (create your credentials by consulting [this guide](https://docs.us.ovhcloud.com/en/manage-and-operate/api/first-steps.md))

 

## Instructions

### Step 1: Configuring vRack

As a mandatory first step, the service must be interconnected with a vRack to enable the configuration.

To get the UUIDs of eligible services, use the following call:

[GET /vrack/{serviceName}/ovhCloudConnect](https://api.us.ovhcloud.com/console/?section=/vrack&branch=v1#get-/vrack/-serviceName-/ovhCloudConnect)

To link your OVHcloud Connect service with the vRack:

[POST /vrack/{serviceName}/ovhCloudConnect](https://api.us.ovhcloud.com/console/?section=/vrack&branch=v1#post-/vrack/-serviceName-/ovhCloudConnect)

#### Information required:

- The **serviceName** of your vRack
- The **ovhCloudConnect** UUID

 

### Step 2: Configuring the PoP

This step is important because you have to choose between L2 and L3.

**Warning:**

**NOTE: **Please be aware of the ramifications of this decision. To switch between L2 and L3 later, you will have to delete the whole configuration.

#### Obtaining the interface ID

To obtain the ID of the interface dedicated to your service, use the following call:

[GET /ovhCloudConnect/{serviceName}/interface](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#get-/ovhCloudConnect/-serviceName-/interface)

The following call provides more service details:

[GET /ovhCloudConnect/{serviceName}/interface/{id}](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#get-/ovhCloudConnect/-serviceName-/interface/-id-)

**Note:**

The LightStatus parameter is refreshed every 5 minutes for monitoring purposes.

 

#### Configuration

##### Layer 2

To create a Layer 2 configuration, use the following call:

[POST /ovhCloudConnect/{serviceName}/config/pop](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#post-/ovhCloudConnect/-serviceName-/config/pop)

##### Information required:

- Your OVHcloud Connect** serviceName**
- The **interfaceID** found in [the previous step](#obtaining-the-interface-id)
- **type:** "l2"

###### Layer 3

The Layer 3 configuration is more complex because of the required BGP settings:

[POST /ovhCloudConnect/{serviceName}/config/pop](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#post-/ovhCloudConnect/-serviceName-/config/pop)

##### Information required:

- Your OVHcloud Connect** serviceName**
- The **customerBgpArea** (your BGP ASN, configured on your device, which will be used for peering)
- The **interfaceID** found in [the previous step](#obtaining-the-interface-id)
- The **ovhBgpArea** (your BGP ASN, configured on the OVHcloud routing instance, pertaining to BGP session and AS path)
- **subnet** (a /30 IPv4 block)
- **type:** "l3"

 

### Step 3: Configuring the data center (DC)

**Note:**

If an OVHcloud Connect service is already configured in the vRack, the second service will inherit the data center configuration.

#### Obtaining available data centers

You can list available data centers for configuration using the following calls:

[GET /ovhCloudConnect/{serviceName}/datacenter](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#get-/ovhCloudConnect/-serviceName-/datacenter)

##### Information required:

- Your OVHcloud Connect** serviceName**

[GET /ovhCloudConnect/{serviceName}/datacenter/{id}](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#get-/ovhCloudConnect/-serviceName-/datacenter/-id-)

##### Information required:

- The **id** of your datacenter
- Your OVHcloud Connect** serviceName**

 

#### Configuration

##### Layer 2

Only the ID of the data center is needed for the L2 configuration:

[POST /ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#post-/ovhCloudConnect/-serviceName-/config/pop/-popId-/datacenter)

##### Information required:

- The **popId** created in [Step 2](#step-2-configuring-the-pop)
- Your OVHcloud Connect** serviceName**
- The **datacenterId** [previously obtained](#obtaining-available-data-centers)

###### Layer 3

More parameters have to be provided for the L3 configuration:

[POST /ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#post-/ovhCloudConnect/-serviceName-/config/pop/-popId-/datacenter)

##### Information required:

- The **popId** created in [Step 2](#step-2-configuring-the-pop).
- Your OVHcloud Connect** serviceName**
- The **datacenterId** [previously obtained](#obtaining-available-data-centers)
- The **ovhBgpArea** (you need to assign an ASN for the OVHcloud routing instance; it will appear in AS path and can be different from the PoP ASN)
- The **subnet** (an IPv4 block; sizes starting at /28 are accepted)

By default, the data centre will be configured with a VRRP instance. You have to proceed with the next steps for static routing or dynamic routing using BGP.
 
**Layer 3 option: Static route**
A static route is needed when you have one or more subnets behind a gateway. This may be a Linux gateway (with IP forwarding enabled), an NSX edge, or any instance capable of routing.

[POST /OVHCLOUDCONNECT/{SERVICENAME}/CONFIG/POP/{POPID}/DATACENTER/{DATACENTERID}/EXTRA /ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter/{datacenterId}/extra](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#post /ovhcloudconnect/{servicename}/config/pop/{popid}/datacenter/{datacenterid}/extra-/ovhCloudConnect/-serviceName-/config/pop/-popId-/datacenter/-datacenterId-/extra)

##### Information required:

- The **datacenterId** [previously obtained](#obtaining-available-data-centers)
- The **popId** created in [Step 2](#step-2-configuring-the-pop).
- Your OVHcloud Connect** serviceName**
- **nextHop** (the IP address in the subnet range acting as the gateway)
- **subnet** (a prefix using the CIDR notation)
- **type:** "network"

 
**Layer 3 option: BGP session**
A BGP session enables dynamic routing from your routing instance with OVHcloud Connect. Announcements are dynamically managed using the BGP protocol. Enabling a BGP session disables the VRRP configuration. You cannot have a BGP session and a static route in the same DC configuration.

[POST /ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter/{datacenterId}/extra](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#post-/ovhCloudConnect/-serviceName-/config/pop/-popId-/datacenter/-datacenterId-/extra)

##### Information required:

- The **datacenterId** [previously obtained](#obtaining-available-data-centers)
- The **popId** created in [Step 2](#step-2-configuring-the-pop).
- Your OVHcloud Connect** serviceName**
- **bgpNeighborArea** (your BGP ASN)
- **bgpNeighborIp** (your IP address in the subnet range)
- **type:** "bgp"

 

### Removing resources

Each resource can be deleted individually, but deleting a parent resource like a DC or PoP will automatically delete all sub-resources. However, recursive deletion is slower than a sequential deletion of each resource.

 

#### Global deletion

The following call recursively deletes the entire configuration of an OVHcloud Connect service:

[DELETE /ovhCloudConnect/{serviceName}/config/pop/{popId}](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#delete-/ovhCloudConnect/-serviceName-/config/pop/-popId-)

Each sub-resource’s status will change from `active` to `toDelete`, but it takes some time to see the status change.

Only one task ID is created.

 

#### Deleting by resource

Each resource can be deleted individually using the following call that will delete the smallest resource (extra):

[DELETE /ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter/{datacenterId}/extra/{extraId}](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#delete-/ovhCloudConnect/-serviceName-/config/pop/-popId-/datacenter/-datacenterId-/extra/-extraId-)

The following call removes the DC configuration and recursively deletes any additional sub-resources:

[DELETE /ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter/{datacenterId}](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#delete-/ovhCloudConnect/-serviceName-/config/pop/-popId-/datacenter/-datacenterId-)

When all sub-resources have been deleted, the PoP configuration can be safely removed:

[DELETE /ovhCloudConnect/{serviceName}/config/pop/{popId}](https://api.us.ovhcloud.com/console/?section=/ovhCloudConnect&branch=v1#delete-/ovhCloudConnect/-serviceName-/config/pop/-popId-)

**Note:**

If a DC configuration is shared between two or more OVHcloud Connect services, deleting the PoP configuration of only one will not affect the DC resource.

 

## Go further

Browse all the [OVHcloud Connect guides](https://docs.us.ovhcloud.com/en/network/ovhcloud-connect/landing-page-ovhcloud-connect.md).

Browse the rest of the [OVHcloud US documentation](https://docs.us.ovhcloud.com/en/index.md) for guides on our other products and services.

Learn more about [OVHcloud Connect](https://us.ovhcloud.com/network/ovhcloud-connect/) on the OVHcloud US website.

If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](https://us.ovhcloud.com/professional-services/) to get a quote and ask our Professional Services experts for a custom analysis of your project.