OVHCloud

Use the Service Key Validation to find Console Connect port information associated with an existing OVH service.

Request

curl 'https://api.consoleconnect.com/api/company/:companyUsername/ports?deleted=false' \
--header 'Authorization: Bearer <API_KEY>' \

Make sure to replace :companyUsername with your actual company username and <API_KEY> with your API key.

Response

You might have multiple ports returned in the results but only choose one.

Take note of the id property since we will use this as the portId.

{
  "results": [
    {
      "id": "66c29b3c6dcad34e5b728c9c", // This property will be the portId of the request payload
      "name": "My-Port-1",
      "speed": {
        "value": 1000,
        "name": "1000 Mbps"
      },
      "tags": [],
      "dataCenterFacilityId": "5aa89b04ac86ba0012345bdf",
      "popId": "99759532-0aeb-4e02-a876-5b505e9b213a",
      "metroId": "77d9f1fbbcaa906f3cddb6d1",
      "companyId": "5d4d056242fbd3000ab4c01d",
      "status": "ACTIVE",
      "updatedAt": "2024-08-19T01:09:16.376Z",
      "createdAt": "2024-08-19T01:09:16.376Z",
      "deleted": false,
      "deletedAt": null,
      "paymentType": "invoice",
      "payg": true
      ...
    }
    ...
  ]
}

Choose Destination Port

Note: You can use the validate OVH key endpoint to retrieve the destPortId.

Request

curl 'https://api.consoleconnect.com/v2/ovh-service-key/validate' \
--data-raw '{"serviceKey":"<YOUR_OVH_KEY>"}' \
--header 'Authorization: Bearer <API_KEY>' \

Make sure to replace <API_KEY> with your API key.

Response

Take note of the portId property since we will use this as the destPortId in request.

{
    "bandwidth": 2000,
    "region": "par-01",
    "portId": "645c8f1b6ae4e90015d8f53b", // This property will be the destPortId of the request payload
    "bandwidthTiers": [
        {
            "type": "AUTOMATIC",
            "value": 200
        },
        {
            "value": 500,
            "type": "AUTOMATIC"
        },
        {
            "value": 1000,
            "type": "AUTOMATIC"
        },
        {
            "value": 2000,
            "type": "AUTOMATIC"
        }
    ],
    "portName": "OVH Paris",
    "dataCenterFacilityId": "5a8ba8c58195000012e9f13f"
}