List NAT Gateway Rules

Perform a GET request to retrieve all rules configured for a specific NAT gateway, including those that translate traffic from internal networks to public IP addresses.

Endpoint

https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules

Request

curl --location \
--request GET 'https://api.ionos.com/cloudapi/v6/datacenters/15f67991-0f51-4efc-a8ad-ef1fb31a480c/natgateways/d8fbc197-d892-48b1-b8e5-e9b8c700abe2/rules' \
--header 'Authorization: Bearer $IONOS_TOKEN'

Parameters

Path Parameters

The following table lists the path parameters:

Path Parameters	Required	Type	Description
datacenterId	Yes	string	The unique ID of the data center.
natGatewayId	Yes	string	The unique ID of the NAT Gateway.

Query Parameters

Request Header Parameters

Response

A 200 OK response indicates that the NAT Gateway rules are successfully listed. Each rule includes its configuration details such as name, type, protocol, IP addresses, and port ranges.

{
  "id": "rules",
  "type": "collection",
  "href": "/datacenters/15f67991-0f51-4efc-a8ad-ef1fb31a480c/natgateways/d8fbc197-d892-48b1-b8e5-e9b8c700abe2/rules",
  "items": [
    {
      "id": "cd589a49-51c8-4bc5-ade5-3f0dc7ed44b4",
      "type": "nat-gateway-rule",
      "href": "/datacenters/15f67991-0f51-4efc-a8ad-ef1fb31a480c/natgateways/d8fbc197-d892-48b1-b8e5-e9b8c700abe2/rules/cd589a49-51c8-4bc5-ade5-3f0dc7ed44b4",
      "metadata": {
        "createdDate": "2024-01-15T09:30:00+00:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2024-01-15T09:30:00+00:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:cloudapi:natgateway:rule:cd589a49-51c8-4bc5-ade5-3f0dc7ed44b4",
        "status": "AVAILABLE",
        "statusMessage": null,
        "publicEndPoint": null
      },
      "properties": {
        "name": "Web Server Rule",
        "type": "SNAT",
        "protocol": "TCP",
        "publicIp": "203.0.113.10",
        "sourceSubnet": "192.168.1.0/24",
        "targetSubnet": "203.0.113.10/32",
        "targetPortRange": {
          "start": 80,
          "end": 80
        }
      }
    },
    {
      "id": "a8f93b12-3d46-4e8f-b7c9-2e4d5f6a7b9c",
      "type": "nat-gateway-rule",
      "href": "/datacenters/15f67991-0f51-4efc-a8ad-ef1fb31a480c/natgateways/d8fbc197-d892-48b1-b8e5-e9b8c700abe2/rules/a8f93b12-3d46-4e8f-b7c9-2e4d5f6a7b9c",
      "metadata": {
        "createdDate": "2024-01-16T14:45:00+00:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2024-01-16T14:45:00+00:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:cloudapi:natgateway:rule:a8f93b12-3d46-4e8f-b7c9-2e4d5f6a7b9c",
        "status": "AVAILABLE",
        "statusMessage": null,
        "publicEndPoint": null
      },
      "properties": {
        "name": "SSH Access Rule",
        "type": "SNAT",
        "protocol": "TCP",
        "publicIp": "203.0.113.11",
        "sourceSubnet": "192.168.2.0/24",
        "targetSubnet": "203.0.113.11/32",
        "targetPortRange": {
          "start": 22,
          "end": 22
        }
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": null,
    "self": "/datacenters/15f67991-0f51-4efc-a8ad-ef1fb31a480c/natgateways/d8fbc197-d892-48b1-b8e5-e9b8c700abe2/rules?offset=0&limit=1000",
    "next": null
  }
}