Get firewall inbound rules

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 alberga las reglas de firewall que se desean consultar. A día de hoy, las que pueden ser mainNetworkId son las redes isoladas.

Necesitaremos obtener el id de este endpoint :

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

Ejemplo Respuesta: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

{
  "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 : GET
Endpoint : /api-gateway/servers/v1/subscriptions/{subscriptionId}/networks/{mainNetworkId}/firewalls/inbounds/rules
Parámetros en el path :
- subscriptionId (del servidor)
- instanceId (del servidor)
Response

{
  "data": [
    {
      "id": "4800",
      "protocol": "tcp",
      "publicNetworkId": "2100",
      "privateNicAddressIpId": "2160",
      "portForwardingId": "4074",
      "publicPort": 4490,
      "privatePort": 34870,
      "origin": "119.92.186.49"
    },
    {
      "id": "string",
      "protocol": "ICMP",
      "publicNetworkId": "string",
      "icmpType": -1,
      "icmpCode": -1,
      "origin": "10.0.0.1"
    }
  ],
  "meta": {
    "correlationId": "f9361103-c1a4-412a-a005-5e307de13d46",
    "timestamp": "2025-05-07T15:44:16Z"
  }
}

{
  "data": [
    {
      "id": "4800",
      "protocol": "tcp",
      "publicNetworkId": "2100",
      "privateNicAddressIpId": "2160",
      "portForwardingId": "4074",
      "publicPort": 4490,
      "privatePort": 34870,
      "origin": "119.92.186.49"
    },
    {
      "id": "string",
      "protocol": "ICMP",
      "publicNetworkId": "string",
      "icmpType": -1,
      "icmpCode": -1,
      "origin": "10.0.0.1"
    }
  ],
  "meta": {
    "correlationId": "f9361103-c1a4-412a-a005-5e307de13d46",
    "timestamp": "2025-05-07T15:44:16Z"
  }
}