Update a Managed NAT Gateway

Update the name or properties of a managed NAT gateway in a Virtual Data Center using a PATCH request. It updates only the specified properties without affecting other settings.

Endpoint

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

Request

curl --location \
--request PATCH 'https://api.ionos.com/cloudapi/v6/datacenters/8feda53f-15f0-447f-badf-ebe32dad2fc0/natgateways/d0989a01-6e5f-41f5-9e6e-0f5f2d3a0c7b' \
--header 'Authorization: Bearer $IONOS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "properties": {
    "name": "Updated NAT Gateway"
  }
}'

Request Body Parameters

The following table lists the request body parameters:

Body Parameters	Required	Type	Description	Example
properties.name	No	string	The name of the NAT Gateway.	Updated NAT Gateway

Request Header Parameters

Response

A 202 Accepted response indicates a successful update to the managed NAT gateway. The resource maintains a BUSY status until the update completes. The id and updated properties are provided in the response.

Note: NAT Gateway updates are performed asynchronously. The response includes a Location header with a URL to poll the request status.

{
  "id": "d0989a01-6e5f-41f5-9e6e-0f5f2d3a0c7b",
  "type": "nat-gateway",
  "href": "/cloudapi/v6/datacenters/8feda53f-15f0-447f-badf-ebe32dad2fc0/natgateways/d0989a01-6e5f-41f5-9e6e-0f5f2d3a0c7b",
  "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-15T10:45:00+00:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:resource:nat-gateway:d0989a01-6e5f-41f5-9e6e-0f5f2d3a0c7b",
    "status": "BUSY",
    "statusMessage": null,
    "publicIps": [
      "198.51.100.45",
      "198.51.100.46"
    ]
  },
  "properties": {
    "name": "Updated NAT Gateway",
    "publicIps": [
      "198.51.100.45",
      "198.51.100.46"
    ],
    "lans": [
      {
        "id": "33",
        "gatewayIps": [
          "10.0.1.1"
        ]
      },
      {
        "id": "34",
        "gatewayIps": [
          "10.0.2.1"
        ]
      }
    ]
  }
}