--- title: Modifier une règle de passerelle NAT par ID slug: modifier-une-regle-de-passerelle-nat-par-id docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "n-0CbQKGSjEodtMLFfTIB", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}" } ], "name": "Modify a NAT Gateway Rule by ID", "description": "Modify the specified NAT Gateway rule.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "datacenterId", "type": "string", "description": "The unique ID of the data center." }, { "kind": "required", "name": "natGatewayId", "type": "string", "description": "The unique ID of the NAT Gateway." }, { "kind": "required", "name": "natGatewayRuleId", "type": "string", "description": "The unique ID of the NAT Gateway rule." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

Controls whether the response is pretty-printed (with indentations and new lines).

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

Controls the detail depth of the response objects.\nGET /datacenters/[ID]\n- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n- depth=1: Direct properties and children references are included.\n- depth=2: Direct properties and children properties are included.\n- depth=3: Direct properties and children properties and children's children are included.\n- depth=... and so on

", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The modified NAT Gateway rule.", "customType": "NatGatewayRulePut", "schema": [ { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NatGatewayRuleProperties", "customType": "NatGatewayRuleProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the NAT Gateway rule.", "example": "My NAT Gateway rule" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "NatGatewayRuleType", "description": "", "modelRef": "#/components/schemas/NatGatewayRuleType", "schema": [] } ], "schema": [] }, { "name": "protocol", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "NatGatewayRuleProtocol", "description": "", "modelRef": "#/components/schemas/NatGatewayRuleProtocol", "schema": [] } ], "schema": [] }, { "name": "sourceSubnet", "kind": "required", "type": "string", "description": "Source subnet of the NAT Gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets source IP address.", "example": "10.0.1.0/24" }, { "name": "publicIp", "kind": "required", "type": "string", "description": "Public IP address of the NAT Gateway rule. Specifies the address used for masking outgoing packets source address field. Should be one of the customer reserved IP address already configured on the NAT Gateway resource", "example": "192.18.7.17" }, { "name": "targetSubnet", "kind": "optional", "type": "string", "description": "

Target or destination subnet of the NAT Gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets destination IP address. If none is provided, rule will match any address.

", "example": "10.0.1.0/24" }, { "name": "targetPortRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TargetPortRange", "customType": "TargetPortRange", "schema": [ { "name": "start", "kind": "optional", "type": "integer", "description": "Target port range start associated with the NAT Gateway rule.", "example": 10000, "format": "int32" }, { "name": "end", "kind": "optional", "type": "integer", "description": "Target port range end associated with the NAT Gateway rule.", "example": 20000, "format": "int32" } ] } ] } ], "modelRef": "#/components/schemas/NatGatewayRulePut", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "202", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "NatGatewayRule", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "description": "

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "description": "

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NatGatewayRuleProperties", "customType": "NatGatewayRuleProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the NAT Gateway rule.", "example": "My NAT Gateway rule" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "NatGatewayRuleType", "description": "", "modelRef": "#/components/schemas/NatGatewayRuleType", "schema": [] } ], "schema": [] }, { "name": "protocol", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "NatGatewayRuleProtocol", "description": "", "modelRef": "#/components/schemas/NatGatewayRuleProtocol", "schema": [] } ], "schema": [] }, { "name": "sourceSubnet", "kind": "required", "type": "string", "description": "Source subnet of the NAT Gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets source IP address.", "example": "10.0.1.0/24" }, { "name": "publicIp", "kind": "required", "type": "string", "description": "Public IP address of the NAT Gateway rule. Specifies the address used for masking outgoing packets source address field. Should be one of the customer reserved IP address already configured on the NAT Gateway resource", "example": "192.18.7.17" }, { "name": "targetSubnet", "kind": "optional", "type": "string", "description": "

Target or destination subnet of the NAT Gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets destination IP address. If none is provided, rule will match any address.

", "example": "10.0.1.0/24" }, { "name": "targetPortRange", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TargetPortRange", "customType": "TargetPortRange", "schema": [ { "name": "start", "kind": "optional", "type": "integer", "description": "Target port range start associated with the NAT Gateway rule.", "example": 10000, "format": "int32" }, { "name": "end", "kind": "optional", "type": "integer", "description": "Target port range end associated with the NAT Gateway rule.", "example": 20000, "format": "int32" } ] } ] } ], "modelRef": "#/components/schemas/NatGatewayRule", "isExpanded": true } ] }, { "statusCode": "default", "description": "

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "9EhltFhPg_6J_FyiFcWeJ", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"type\": {},\n \"properties\": {\n \"name\": \"My NAT Gateway rule\",\n \"type\": {},\n \"protocol\": {},\n \"sourceSubnet\": \"10.0.1.0/24\",\n \"publicIp\": \"192.18.7.17\"\n }\n }'" }, { "id": "Rl9yXu_tEBTHHChZNa3H-", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"type\": {},\n \"properties\": {\n \"name\": \"My NAT Gateway rule\",\n \"type\": {},\n \"protocol\": {},\n \"sourceSubnet\": \"10.0.1.0/24\",\n \"publicIp\": \"192.18.7.17\"\n }\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "dq7Nivb_8X1Oik8Tht9nq", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"type\": {},\n \"properties\": {\n \"name\": \"My NAT Gateway rule\",\n \"type\": {},\n \"protocol\": {},\n \"sourceSubnet\": \"10.0.1.0/24\",\n \"publicIp\": \"192.18.7.17\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "UgbhRNBLNLGpxzx71ZOG6", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}?pretty=true&depth=integer\"\n\npayload = json.dumps({\n \"type\": {},\n \"properties\": {\n \"name\": \"My NAT Gateway rule\",\n \"type\": {},\n \"protocol\": {},\n \"sourceSubnet\": \"10.0.1.0/24\",\n \"publicIp\": \"192.18.7.17\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "9EhltFhPg_6J_FyiFcWeJ" }, "results": { "languages": [ { "id": "0SS-JYqWs5hjvSam1jn7E", "language": "202", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My NAT Gateway rule\",\n \"type\": {},\n \"protocol\": {},\n \"sourceSubnet\": \"10.0.1.0/24\",\n \"publicIp\": \"192.18.7.17\",\n \"targetSubnet\": \"10.0.1.0/24\",\n \"targetPortRange\": {\n \"start\": 10000,\n \"end\": 20000\n }\n }\n}" }, { "id": "XLLl5bL_3aZlM3vEjOA7v", "language": "default", "code": "// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "0SS-JYqWs5hjvSam1jn7E" } }, "children": [ { "text": "", "id": "xg96d5gCYl2hnxBUkfVQy" } ] }