CloudConnexa: Guide to Create a Host IP Service with Custom Ports Using the API via Swagger

Description: This guide provides step-by-step instructions for creating a Host IP Service with custom ports in CloudConnexa using the public API through Swagger.

Step 1: Create API credentials

1. Sign in to your CloudConnexa Portal.
2. Click API & Logs > API.
3. Click Create Credentials.
   
4. Enter the details for your new credentials and click Create.
   
5. Once the credentials are created, copy the Public API Client ID and Public API Client Secret, which you'll use as your authorization credentials using Swagger.
   
6. Return to the CloudConnexa API UI and turn on Enable API for this Cloud ID to ensure active API access.
   

Step 2: Authorize in Swagger

1. From the CloudConnexa API UI, click Swagger.
   
2. Click Authorize.
3. Paste your Public API Client ID and Public API Client Secret, and click Authorize.
   
   • The Available authorizations notification displays, and you can click Close.

Step 3: Ensure your Hosts is created

If you haven't created a Host yet, follow this guide first: CloudConnexa: How to Create Hosts using the CloudConnexa API via Swagger.

Once your Host is ready, continue with the next step.

Step 4: Retrieve your Hosts ID

1. In Swagger, click to expand GET /api/v1/hosts under Host.
2. Click Try it out, then Execute.
   
3. From the response, copy the Host ID of the Host you want to use.
   

Step 5: Create an IP Service

1. In Swagger, click to expand POST /api/v1/hosts/ip-services .
2. Click Try it out and paste the copied Host ID in the hostId field.
3. Make your changes to define your custom application in the Request body.

   {
     "name": "RDP",
     "description": "TCP Port 3389",
     "config": {
       "serviceTypes": [
         "CUSTOM"
       ],
       "customServiceTypes": [
         {
           "protocol": "TCP",
           "port": [
             {
               "lowerValue": 3389,
               "upperValue": 3389
             }
           ]
         }
       ]
     }
   }

4. Click Execute to submit the request.
   

Step 6: Verify the IP Service in your CloudConnexa portal

1. Sign in to your CloudConnexa Portal.
2. Click Hosts > IP Services.
3. Confirm the executed CloudConnexa API parameters.
   

If you require further assistance, please submit a support ticket.