Update a NAT port-forwarding rule

PATCH

/networking/vpcs/:vpc_id/nat-gateways/:nat_gateway_id/port-forwarding-rules/:port_forwarding_rule_id

PATCH

/v1/networking/vpcs/:vpc_id/nat-gateways/:nat_gateway_id/port-forwarding-rules/:port_forwarding_rule_id

$ curl -X PATCH "https://api.ibee.ai/v1/networking/vpcs/vpc_id/nat-gateways/nat_gateway_id/port-forwarding-rules/port_forwarding_rule_id?workspace_id=710995" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "name": "string",
3   "external_port": 1,
4   "internal_ip": "string",
5   "internal_port": 1,
6   "port_forward_rule_id": "string",
7   "vpc_id": "string",
8   "nat_gateway_id": "string",
9   "status": "provisioning",
10   "created_at": "2024-01-15T09:30:00Z",
11   "updated_at": "2024-01-15T09:30:00Z",
12   "protocol": "tcp",
13   "note": "",
14   "enabled": true,
15   "organization_id": "string",
16   "workspace_id": "string",
17   "site_id": "string",
18   "error_message": "string"
19 }

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

vpc_idstringRequired

VPC ID.

nat_gateway_idstringRequired

NAT gateway ID.

port_forwarding_rule_idstringRequired

NAT port-forwarding rule ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.

namestringOptional1-80 characters

protocolenumOptional

external_portintegerOptional1-65535

internal_ipstringOptional

internal_portintegerOptional1-65535

notestringOptional<=500 characters

enabledbooleanOptional

Response

Port-forwarding rule updated successfully.

namestring1-80 characters

external_portinteger1-65535

internal_ipstring

internal_portinteger1-65535

port_forward_rule_idstring

vpc_idstring

nat_gateway_idstring

statusenum

created_atdatetime

updated_atdatetime

protocolenumOptionalDefaults to tcp

notestringOptional<=500 charactersDefaults to

enabledbooleanOptionalDefaults to true

organization_idstringOptional

workspace_idstringOptional

site_idstringOptional

error_messagestring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error