Edges Tcp

Create TCP Edge

Create a TCP Edge

Request

POST /edges/tcp

Example Request

curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"acme tcp edge","metadata":"{\"environment\": \"staging\"}"}' \
https://api.ngrok.com/edges/tcp

Parameters

Name	Type	Description
description	string	human-readable description of what this edge will be used for; optional, max 255 bytes.
metadata	string	arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports	List<string>	hostports served by this edge
backend	EndpointBackendMutate	edge modules
ip_restriction	EndpointIPPolicyMutate
policy	EndpointPolicy	the traffic policy associated with this edge or null

EndpointBackendMutate parameters

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
backend_id	string	backend to be used to back this endpoint

EndpointIPPolicyMutate parameters

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
ip_policy_ids	List<string>	list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

EndpointPolicy parameters

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
inbound	EndpointRule	the inbound rules of the traffic policy.
outbound	EndpointRule	the outbound rules on the traffic policy.

EndpointRule parameters

Name	Type	Description
expressions	List<string>	cel expressions that filter traffic the policy rule applies to.
actions	EndpointAction	the set of actions on a policy rule.
name	string	the name of the rule that is part of the traffic policy.

EndpointAction parameters

Name	Type	Description
type	string	the type of action on the policy rule.
config	object	the configuration for the action on the policy rule.

Response

Returns a 201 response on success

Example Response

{
	"backend": null,
	"created_at": "2024-05-23T20:36:26Z",
	"description": "acme tcp edge",
	"hostports": null,
	"id": "edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA",
	"ip_restriction": null,
	"metadata": "{\"environment\": \"staging\"}",
	"policy": null,
	"uri": "https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA"
}

Fields

Name	Type	Description
id	string	unique identifier of this edge
description	string	human-readable description of what this edge will be used for; optional, max 255 bytes.
metadata	string	arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
created_at	string	timestamp when the edge was created, RFC 3339 format
uri	string	URI of the edge API resource
hostports	List<string>	hostports served by this edge
backend	EndpointBackend	edge modules
ip_restriction	EndpointIPPolicy
policy	EndpointPolicy	the traffic policy associated with this edge or null

EndpointBackend fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
backend	Ref	backend to be used to back this endpoint

Ref fields

Name	Type	Description
id	string	a resource identifier
uri	string	a uri for locating a resource

EndpointIPPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
ip_policies	Ref	list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

EndpointPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
inbound	EndpointRule	the inbound rules of the traffic policy.
outbound	EndpointRule	the outbound rules on the traffic policy.

EndpointRule fields

Name	Type	Description
expressions	List<string>	cel expressions that filter traffic the policy rule applies to.
actions	EndpointAction	the set of actions on a policy rule.
name	string	the name of the rule that is part of the traffic policy.

EndpointAction fields

Name	Type	Description
type	string	the type of action on the policy rule.
config	object	the configuration for the action on the policy rule.

Get TCP Edge

Get a TCP Edge by ID

Request

GET /edges/tcp/{id}

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA

Response

Returns a 200 response on success

Example Response

{
	"backend": null,
	"created_at": "2024-05-23T20:36:26Z",
	"description": "acme tcp edge",
	"hostports": null,
	"id": "edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA",
	"ip_restriction": null,
	"metadata": "{\"environment\": \"staging\"}",
	"policy": null,
	"uri": "https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA"
}

Fields

Name	Type	Description
id	string	unique identifier of this edge
description	string	human-readable description of what this edge will be used for; optional, max 255 bytes.
metadata	string	arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
created_at	string	timestamp when the edge was created, RFC 3339 format
uri	string	URI of the edge API resource
hostports	List<string>	hostports served by this edge
backend	EndpointBackend	edge modules
ip_restriction	EndpointIPPolicy
policy	EndpointPolicy	the traffic policy associated with this edge or null

EndpointBackend fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
backend	Ref	backend to be used to back this endpoint

Ref fields

Name	Type	Description
id	string	a resource identifier
uri	string	a uri for locating a resource

EndpointIPPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
ip_policies	Ref	list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

EndpointPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
inbound	EndpointRule	the inbound rules of the traffic policy.
outbound	EndpointRule	the outbound rules on the traffic policy.

EndpointRule fields

Name	Type	Description
expressions	List<string>	cel expressions that filter traffic the policy rule applies to.
actions	EndpointAction	the set of actions on a policy rule.
name	string	the name of the rule that is part of the traffic policy.

EndpointAction fields

Name	Type	Description
type	string	the type of action on the policy rule.
config	object	the configuration for the action on the policy rule.

List TCP Edges

Returns a list of all TCP Edges on this account

Request

GET /edges/tcp

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tcp

Response

Returns a 200 response on success

Example Response

{
	"next_page_uri": null,
	"tcp_edges": [
		{
			"backend": null,
			"created_at": "2024-05-23T20:36:26Z",
			"description": "acme tcp edge",
			"hostports": null,
			"id": "edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA",
			"ip_restriction": null,
			"metadata": "{\"environment\": \"staging\"}",
			"policy": null,
			"uri": "https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA"
		}
	],
	"uri": "https://api.ngrok.com/edges/tcp"
}

Fields

Name	Type	Description
tcp_edges	TCPEdge	the list of all TCP Edges on this account
uri	string	URI of the TCP Edge list API resource
next_page_uri	string	URI of the next page, or null if there is no next page

TCPEdge fields

Name	Type	Description
id	string	unique identifier of this edge
description	string	human-readable description of what this edge will be used for; optional, max 255 bytes.
metadata	string	arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
created_at	string	timestamp when the edge was created, RFC 3339 format
uri	string	URI of the edge API resource
hostports	List<string>	hostports served by this edge
backend	EndpointBackend	edge modules
ip_restriction	EndpointIPPolicy
policy	EndpointPolicy	the traffic policy associated with this edge or null

EndpointBackend fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
backend	Ref	backend to be used to back this endpoint

Ref fields

Name	Type	Description
id	string	a resource identifier
uri	string	a uri for locating a resource

EndpointIPPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
ip_policies	Ref	list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

EndpointPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
inbound	EndpointRule	the inbound rules of the traffic policy.
outbound	EndpointRule	the outbound rules on the traffic policy.

EndpointRule fields

Name	Type	Description
expressions	List<string>	cel expressions that filter traffic the policy rule applies to.
actions	EndpointAction	the set of actions on a policy rule.
name	string	the name of the rule that is part of the traffic policy.

EndpointAction fields

Name	Type	Description
type	string	the type of action on the policy rule.
config	object	the configuration for the action on the policy rule.

Update TCP Edge

Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

Request

PATCH /edges/tcp/{id}

Example Request

curl \
-X PATCH \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"metadata":"{\"environment\": \"production\"}"}' \
https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA

Parameters

Name	Type	Description
id	string	unique identifier of this edge
description	string	human-readable description of what this edge will be used for; optional, max 255 bytes.
metadata	string	arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports	List<string>	hostports served by this edge
backend	EndpointBackendMutate	edge modules
ip_restriction	EndpointIPPolicyMutate
policy	EndpointPolicy	the traffic policy associated with this edge or null

EndpointBackendMutate parameters

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
backend_id	string	backend to be used to back this endpoint

EndpointIPPolicyMutate parameters

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
ip_policy_ids	List<string>	list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

EndpointPolicy parameters

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
inbound	EndpointRule	the inbound rules of the traffic policy.
outbound	EndpointRule	the outbound rules on the traffic policy.

EndpointRule parameters

Name	Type	Description
expressions	List<string>	cel expressions that filter traffic the policy rule applies to.
actions	EndpointAction	the set of actions on a policy rule.
name	string	the name of the rule that is part of the traffic policy.

EndpointAction parameters

Name	Type	Description
type	string	the type of action on the policy rule.
config	object	the configuration for the action on the policy rule.

Response

Returns a 200 response on success

Example Response

{
	"backend": null,
	"created_at": "2024-05-23T20:36:26Z",
	"description": "acme tcp edge",
	"hostports": null,
	"id": "edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA",
	"ip_restriction": null,
	"metadata": "{\"environment\": \"production\"}",
	"policy": null,
	"uri": "https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA"
}

Fields

Name	Type	Description
id	string	unique identifier of this edge
description	string	human-readable description of what this edge will be used for; optional, max 255 bytes.
metadata	string	arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
created_at	string	timestamp when the edge was created, RFC 3339 format
uri	string	URI of the edge API resource
hostports	List<string>	hostports served by this edge
backend	EndpointBackend	edge modules
ip_restriction	EndpointIPPolicy
policy	EndpointPolicy	the traffic policy associated with this edge or null

EndpointBackend fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
backend	Ref	backend to be used to back this endpoint

Ref fields

Name	Type	Description
id	string	a resource identifier
uri	string	a uri for locating a resource

EndpointIPPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
ip_policies	Ref	list of all IP policies that will be used to check if a source IP is allowed access to the endpoint

EndpointPolicy fields

Name	Type	Description
enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
inbound	EndpointRule	the inbound rules of the traffic policy.
outbound	EndpointRule	the outbound rules on the traffic policy.

EndpointRule fields

Name	Type	Description
expressions	List<string>	cel expressions that filter traffic the policy rule applies to.
actions	EndpointAction	the set of actions on a policy rule.
name	string	the name of the rule that is part of the traffic policy.

EndpointAction fields

Name	Type	Description
type	string	the type of action on the policy rule.
config	object	the configuration for the action on the policy rule.

Delete TCP Edge

Delete a TCP Edge by ID

Request

DELETE /edges/tcp/{id}

Example Request

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tcp/edgtcp_2gsqMlMqxCWrr4fb2sVjGuahNmA

Response

Returns a 204 response with no body on success