API Reference

List network interfaces connected to the instance

Con este endpoint obtendremos la información de las tarjetas de red que contiene 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"
  }
}

Resumen

  • Verbo HTTPS : GET

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

  • Parámetros en el path :

    • subscriptionId (del servidor)

    • instanceId (del servidor)

  • Response

{
  "data": [
    {
      "id": "2163",
      "mainNetworkId": "2229",
      "addressIpPrimary": "10.0.0.248",
      "isDefault": true,
      "mac": "02:00:7b:2f:00:01"
    },
    {
      "id": "2166",
      "mainNetworkId": "2232",
      "addressIpPrimary": "192.168.10.149",
      "isDefault": false,
      "mac": "02:00:17:74:00:01"
    }
  ],
  "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!