CloudConnexa: Guide to Create Network Applications using CloudConnexa API via Swagger

Description: This guide provides step-by-step instructions for creating a network application 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 network is created

If you haven't already created a network in CloudConnexa, follow this article: CloudConnexa: How to Create Networks using the CloudConnexa API via Swagger.

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

Step 4: Retrieve your Network ID

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

Step 5: Create an application

1. In Swagger, click to expand POST /api/v1/networks/applications.
2. Click Try it out and paste the copied network ID in the networkId field.
3. Make your changes to define your custom application in the Request body.
   Example:

   {
     "name": "Webmin Internal Site",
     "description": "Internal",
     "routes": [
       {
         "type": "domain",
         "value": "weblink.system-administrator.click",
         "allowEmbeddedIp": false
       }
     ],
     "config": {
       "serviceTypes": [
         "ANY"
       ]
     }
   }

4. Click Execute to submit the request.
   

Step 6: Verify the application in your CloudConnexa portal

1. Sign in to your CloudConnexa Portal.
2. Click Networks > Applications.
3. Confirm the executed CloudConnexa API parameters.
   

If you need additional help, please submit a support ticket.