Skip to main content
Server path: /ngrok-tunnels | Type: Application | PCID required: Yes

Tools


ngrok_tunnels_agent_ingresses_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
certificate_management_policyobjectNoCertificate Management Policy
descriptionstringNohuman-readable description of the use of this Agent Ingress. optional, max 255 bytes.
domainstringYesthe domain that you own to be used as the base domain name to generate regional agent ingress domains.
metadatastringNoarbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

ngrok_tunnels_agent_ingresses_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_agent_ingresses_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_agent_ingresses_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_tunnels_agent_ingresses_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
certificate_management_policyobjectNoCertificate Management Policy
descriptionstringNohuman-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadatastringNoarbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

ngrok_tunnels_endpoints_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
bindingsstring[]Nothe bindings associated with this endpoint
descriptionstringNouser-supplied description of the associated tunnel
metadatastringNouser-supplied metadata of the associated tunnel or edge object
pooling_enabledbooleanNon/a
traffic_policystringYesThe traffic policy attached to this endpoint
typestringYesType of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.
urlstringYesthe url of the endpoint

ngrok_tunnels_endpoints_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_endpoints_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_endpoints_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
idany[]NoFilter results by endpoint IDs. Deprecated: use filter instead.
urlany[]NoFilter results by endpoint URLs. Deprecated: use filter instead.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_tunnels_endpoints_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesunique endpoint resource identifier
bindingsstring[]Nothe bindings associated with this endpoint
descriptionstringNouser-supplied description of the associated tunnel
metadatastringNouser-supplied metadata of the associated tunnel or edge object
pooling_enabledbooleanNon/a
traffic_policystringNoThe traffic policy attached to this endpoint
urlstringNothe url of the endpoint

ngrok_tunnels_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoBefore Id
limitstringNoMaximum number of results to return

ngrok_tunnels_reserved_addrs_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNohuman-readable description of what this reserved address will be used for
metadatastringNoarbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
regionstringNoreserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

ngrok_tunnels_reserved_addrs_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_reserved_addrs_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_reserved_addrs_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_tunnels_reserved_addrs_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
descriptionstringNohuman-readable description of what this reserved address will be used for
metadatastringNoarbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

ngrok_tunnels_reserved_domains_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
certificate_idstringNoID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
certificate_management_policyobjectNoCertificate Management Policy
descriptionstringNohuman-readable description of what this reserved domain will be used for
domainstringNohostname of the reserved domain
metadatastringNoarbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
regionstringNodeprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)
resolves_toobject[]NoDNS resolver targets configured for the reserved domain, or empty for “global” resolution.

ngrok_tunnels_reserved_domains_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_reserved_domains_delete_certificate

DeleteCertificate Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_reserved_domains_delete_certificate_management_policy

DeleteCertificateManagementPolicy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_reserved_domains_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_reserved_domains_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_tunnels_reserved_domains_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
certificate_idstringNoID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
certificate_management_policyobjectNoCertificate Management Policy
descriptionstringNohuman-readable description of what this reserved domain will be used for
metadatastringNoarbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
resolves_toobject[]NoDNS resolver targets configured for the reserved domain, or empty for “global” resolution.

ngrok_tunnels_tunnel_sessions_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_tunnel_sessions_list

List Parameters:
ParameterTypeRequiredDefaultDescription
before_idstringNoExpects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limitstringNoConstrains the number of results in the dataset. See the API Overview for details.
filterstringNoA CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

ngrok_tunnels_tunnel_sessions_restart

Restart Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_tunnel_sessions_stop

Stop Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_tunnels_tunnel_sessions_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value