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, and this page is available as Markdown at https://docs.us.ovhcloud.com/en/network/ovhcloud-connect/configuration-using-apiv6.md.
  • English

OVHcloud Connect - Configuration using the OVHcloud APIv6

View as Markdown

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 and configure your network devices accordingly.

 

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

To link your OVHcloud Connect service with the vRack:

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

The following call provides more service details:

GET/ovhCloudConnect/{serviceName}/interface/{id}
Info

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

 

Configuration

Layer 2
Layer 3

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

POST/ovhCloudConnect/{serviceName}/config/pop
Information required:
  • Your OVHcloud Connect serviceName
  • The interfaceID found in the previous step
  • type: "l2"

 

Step 3: Configuring the data center (DC)

Info

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
Information required:
  • Your OVHcloud Connect serviceName
GET/ovhCloudConnect/{serviceName}/datacenter/{id}
Information required:
  • The id of your datacenter
  • Your OVHcloud Connect serviceName

 

Configuration

Layer 2
Layer 3

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

POST/ovhCloudConnect/{serviceName}/config/pop/{popId}/datacenter
Information required:

 

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}

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}

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

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}
Info

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.

Browse the rest of the OVHcloud US documentation for guides on our other products and services.

Learn more about 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 to get a quote and ask our Professional Services experts for a custom analysis of your project.