Create a NAT port-forwarding rule | ibee

curl -X POST "https://api.ibee.co.in/v1/networking/vpcs/vpc_id/nat-gateways/nat_gateway_id/port-forwarding-rules?workspace_id=workspace_id" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "external_port": 1,
  "internal_ip": "string",
  "internal_port": 1
}'

{
  "name": "string",
  "external_port": 1,
  "internal_ip": "string",
  "internal_port": 1,
  "port_forward_rule_id": "string",
  "vpc_id": "string",
  "nat_gateway_id": "string",
  "status": "provisioning",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "protocol": "tcp",
  "note": "",
  "enabled": true,
  "organization_id": "string",
  "workspace_id": "string",
  "site_id": "string",
  "error_message": "string"
}

Authentication

AuthorizationBearer

IBEE platform API token, for example: ibee_live_xxx.

Path parameters

vpc_idstringRequired

VPC ID.

nat_gateway_idstringRequired

NAT gateway ID.

Query parameters

workspace_idstringRequired

The workspace ID to scope this request to.

Request

This endpoint expects an object.

namestringRequired1-80 characters

external_portintegerRequired1-65535

internal_ipstringRequired

internal_portintegerRequired1-65535

protocolenumOptionalDefaults to tcp

notestringOptional<=500 charactersDefaults to

enabledbooleanOptionalDefaults to true

Response

Port-forwarding rule created 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

protocolenumDefaults to tcp

notestring<=500 charactersDefaults to

enabledbooleanDefaults to true

organization_idstring

workspace_idstring

site_idstring

error_messagestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error