API Reference

Create an isolated network

Con este endpoint podremos crear una red isolada asociada a una suscripción de servidor.

Prerequisitos

OrganizationId

Necesitaremos conocer nuestro organizacionId.

Para obtener dicha información utilizaremos este endpoint :

GET : /api-gateway/core/v1/organizations

Ejemplo Respuesta :

{
	"data": [
		{
			"id": "1",
			"name": "Nombre Organizacion"
		}
	],
	"meta": {
		"correlationId": "5b1c3dc2-ffe9-4a72-8944-a75d385094f1",
		"timestamp": "2025-05-05T14:26:10Z"
	}
}

ServerSubscriptionId

Necesitamos obtener el serverSubscriptionId del servidor del que queremos obtener los datos. Será el valor de id el que recuperaremos. Para ello utilizamos este endpoint :

GET: /api-gateway/servers/v1/organizations/{organizationId}/subscriptions

Ejemplo Respuesta:

{
  "data": [
    {
      "id": "7002",
      "name": "Test Server",
      "createdAt": "2025-04-11T12:03:15.000Z",
      "updatedAt": "2025-04-11T12:03:31.000Z"
    },
    {
      "id": "7005",
      "name": "Servidores #1",
      "createdAt": "2025-04-11T12:15:03.000Z",
      "updatedAt": "2025-04-11T12:15:05.000Z"
    }
  ],
  "meta": {
    "correlationId": "72569db4-32a8-42d1-ae66-6fcd65794dcb",
    "timestamp": "2025-05-07T15:26:15Z"
  }
}

Resumen

  • Verbo HTTPS : POST

  • Endpoint : /api-gateway/servers/v1/subscriptions/{subscriptionId}/networks/isolated-networks

  • Parámetros en el path :

    • subscriptionId (del servidor)
  • Parámetros en el body

CampoTipoObligatorioDescripciónEjemplo
namestringNombre de la red isolada"Red Isolada 1"
networkstringIP de la red"192.168.10.0"
netmaskstringMáscara de subred"255.255.255.0"
gatewaystringGateway IP"192.168.10.1"
  • Request Body
{
  "data": {
    "name": "Red Isolada 1",
    "network": "192.168.10.0",
    "netmask": "255.255.255.0",
    "gateway": "example: 192.168.10.1"
  },
  "meta": {
    "requestId": "f9361103-c1a4-412a-a005-5e307de13d46",
    "timestamp": "2025-05-07T15:44:16Z"
  }
}
  • Response (201 Created)
  • {
      "data": {
        "id": "2232",
        "subscriptionId": "7002",
        "mainNetworkId": "2232",
        "name": "Red Isolada 1",
        "gateway": "192.168.10.1",
        "netmask": "255.255.255.0",
        "cidr": "192.168.10.0/24",
        "zone": "EU-DEV1",
        "createdAt": "2025-04-11T12:07:18.000Z",
        "updatedAt": "2025-04-11T12:07:18.000Z"
      },
      "meta": {
        "correlationId": "f9361103-c1a4-412a-a005-5e307de13d46",
        "timestamp": "2025-05-07T15:44:16Z"
      }
    }

Language
URL
Click Try It! to start a request and see the response here!