API Reference

Create network interfaces connected to the instance

Con este endpoint podremos crear una nueva tarjeta de red en una instancia

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

ServerInstanceId

Necesitamos obtener el serverInstanceId 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/subscriptions/{subscriptionId}/instances

Ejemplo Respuesta:

{
  "data": [
    {
      "id": "3333",
      "subscriptionId": "7002",
      "zone": "EU-DEV1",
      "templateId": "Ubuntu 24.04 LTS x64",
      "offeringId": "1 Core - 1GB RAM",
      "state": "running",
      "name": "Test",
      "createdAt": "2025-04-11T12:03:52.000Z",
      "updatedAt": "2025-04-11T12:04:48.000Z"
    }
  ],
  "meta": {
    "correlationId": "e8a85097-e478-4c4e-8ead-80adeac5437b",
    "timestamp": "2025-05-07T15:33:33Z"
  }
}

MainNetworkId

Necesitamos obtener el mainNetworkId que tendrá esta tarjeta de red. A día de hoy, las que pueden ser mainNetworkId son las redes isoladas.

Si no tenemos ninguna red compatible con mainNetwork, tendremos primero que crearla. Para ello seguir estos pasos: Crear red isolada.

⚠️

Cada mainNetwork debe ser única para su tarjeta de red. Si no tienes ninguna mainNetwork que no esté siendo utilizada ya, deberás crear una nueva:Crear red isolada.

Necesitaremos obtener el id de este endpoint :

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

Ejemplo Respuesta:

{
  "data": [
    {
      "id": "2229",
      "subscriptionId": "7002",
      "mainNetworkId": "2229",
      "name": "INT-pre15-SAJU00-EU-DEV1-556",
      "gateway": "10.0.0.254",
      "netmask": "255.255.255.0",
      "cidr": "10.0.0.0/24",
      "zone": "EU-DEV1",
      "createdAt": "2025-04-11T12:03:55.000Z",
      "updatedAt": "2025-04-11T12:03:55.000Z"
    },
    {
      "id": "2232",
      "subscriptionId": "7002",
      "mainNetworkId": "2232",
      "name": "Test Network 0",
      "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": "fc48de38-32d5-4c79-9003-06ea3da8a363",
    "timestamp": "2025-05-07T15:50:08Z"
  }
}

Resumen

  • Verbo HTTPS : POST

  • Endpoint : /api-gateway/servers/v1/subscriptions/{subscriptionId}/instances/{instanceId}/nics

  • Parámetros en el path :

    • subscriptionId (del servidor)

    • instanceId (del servidor)

  • Parámetros en el body

CampoTipoObligatorioDescripciónEjemplo
mainNetworkIdstringIdentificador de mainNetwork"2229"
addressIpPrimarystringNoIP primaria"192.168.1.15"
macstringNoDirección MAC"00:11:22:33:44:55"
  • Request Body
{
  "data": {
    "mainNetworkId": "2229",
    "addressIpPrimary": "192.168.1.15",
    "mac": "00:11:22:33:44:55"
  },
  "meta": {
    "requestId": "f9361103-c1a4-412a-a005-5e307de13d46",
    "timestamp": "2025-05-07T15:44:16Z"
  }
}
  • Response
{
  "data": [
    {
      "id": "2167",
      "mainNetworkId": "2229"
    }
  ],
  "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!