/ngrok-tunnels | Type: Application | PCID required: Yes
Tools
ngrok_tunnels_agent_ingresses_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
certificate_management_policy | object | No | — | Certificate Management Policy |
description | string | No | — | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
domain | string | Yes | — | the domain that you own to be used as the base domain name to generate regional agent ingress domains. |
metadata | string | No | — | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_management_policy": {
"type": "object",
"description": "Certificate Management Policy",
"properties": {
"authority": {
"type": "string",
"description": "certificate authority to request certificates from. The only supported value is letsencrypt."
},
"private_key_type": {
"type": "string",
"description": "type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa."
}
}
},
"description": {
"type": "string",
"description": "human-readable description of the use of this Agent Ingress. optional, max 255 bytes."
},
"domain": {
"type": "string",
"description": "the domain that you own to be used as the base domain name to generate regional agent ingress domains."
},
"metadata": {
"type": "string",
"description": "arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes"
}
},
"required": [
"PCID",
"domain"
]
}
ngrok_tunnels_agent_ingresses_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_agent_ingresses_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_agent_ingresses_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before_id | string | No | — | Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. |
limit | string | No | — | Constrains the number of results in the dataset. See the API Overview for details. |
filter | string | No | — | A 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before_id": {
"type": "string",
"description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
},
"limit": {
"type": "string",
"description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
},
"filter": {
"type": "string",
"description": "A 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."
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_agent_ingresses_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
certificate_management_policy | object | No | — | Certificate Management Policy |
description | string | No | — | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | No | — | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"certificate_management_policy": {
"type": "object",
"description": "Certificate Management Policy",
"properties": {
"authority": {
"type": "string",
"description": "certificate authority to request certificates from. The only supported value is letsencrypt."
},
"private_key_type": {
"type": "string",
"description": "type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa."
}
}
},
"description": {
"type": "string",
"description": "human-readable description of the use of this Agent Ingress. optional, max 255 bytes."
},
"metadata": {
"type": "string",
"description": "arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_endpoints_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bindings | string[] | No | — | the bindings associated with this endpoint |
description | string | No | — | user-supplied description of the associated tunnel |
metadata | string | No | — | user-supplied metadata of the associated tunnel or edge object |
pooling_enabled | boolean | No | — | n/a |
traffic_policy | string | Yes | — | The traffic policy attached to this endpoint |
type | string | Yes | — | Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified. |
url | string | Yes | — | the url of the endpoint |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"bindings": {
"type": "array",
"items": {
"type": "string"
},
"description": "the bindings associated with this endpoint"
},
"description": {
"type": "string",
"description": "user-supplied description of the associated tunnel"
},
"metadata": {
"type": "string",
"description": "user-supplied metadata of the associated tunnel or edge object"
},
"pooling_enabled": {
"type": "boolean",
"description": "n/a"
},
"traffic_policy": {
"type": "string",
"description": "The traffic policy attached to this endpoint"
},
"type": {
"type": "string",
"description": "Type of endpoint. Only 'cloud' is currently supported (represents a cloud endpoint). Defaults to 'cloud' if not specified."
},
"url": {
"type": "string",
"description": "the url of the endpoint"
}
},
"required": [
"PCID",
"traffic_policy",
"type",
"url"
]
}
ngrok_tunnels_endpoints_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_endpoints_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_endpoints_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before_id | string | No | — | Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. |
limit | string | No | — | Constrains the number of results in the dataset. See the API Overview for details. |
id | any[] | No | — | Filter results by endpoint IDs. Deprecated: use filter instead. |
url | any[] | No | — | Filter results by endpoint URLs. Deprecated: use filter instead. |
filter | string | No | — | A 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before_id": {
"type": "string",
"description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
},
"limit": {
"type": "string",
"description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
},
"id": {
"type": "array",
"description": "Filter results by endpoint IDs. Deprecated: use `filter` instead."
},
"url": {
"type": "array",
"description": "Filter results by endpoint URLs. Deprecated: use `filter` instead."
},
"filter": {
"type": "string",
"description": "A 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."
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_endpoints_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | unique endpoint resource identifier |
bindings | string[] | No | — | the bindings associated with this endpoint |
description | string | No | — | user-supplied description of the associated tunnel |
metadata | string | No | — | user-supplied metadata of the associated tunnel or edge object |
pooling_enabled | boolean | No | — | n/a |
traffic_policy | string | No | — | The traffic policy attached to this endpoint |
url | string | No | — | the url of the endpoint |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "unique endpoint resource identifier"
},
"bindings": {
"type": "array",
"items": {
"type": "string"
},
"description": "the bindings associated with this endpoint"
},
"description": {
"type": "string",
"description": "user-supplied description of the associated tunnel"
},
"metadata": {
"type": "string",
"description": "user-supplied metadata of the associated tunnel or edge object"
},
"pooling_enabled": {
"type": "boolean",
"description": "n/a"
},
"traffic_policy": {
"type": "string",
"description": "The traffic policy attached to this endpoint"
},
"url": {
"type": "string",
"description": "the url of the endpoint"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before_id | string | No | — | Before Id |
limit | string | No | — | Maximum number of results to return |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before_id": {
"type": "string",
"description": "Before Id"
},
"limit": {
"type": "string",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_reserved_addrs_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | human-readable description of what this reserved address will be used for |
metadata | string | No | — | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
region | string | No | — | reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "human-readable description of what this reserved address will be used for"
},
"metadata": {
"type": "string",
"description": "arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes."
},
"region": {
"type": "string",
"description": "reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_reserved_addrs_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_addrs_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_addrs_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before_id | string | No | — | Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. |
limit | string | No | — | Constrains the number of results in the dataset. See the API Overview for details. |
filter | string | No | — | A 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before_id": {
"type": "string",
"description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
},
"limit": {
"type": "string",
"description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
},
"filter": {
"type": "string",
"description": "A 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."
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_reserved_addrs_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
description | string | No | — | human-readable description of what this reserved address will be used for |
metadata | string | No | — | arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"description": {
"type": "string",
"description": "human-readable description of what this reserved address will be used for"
},
"metadata": {
"type": "string",
"description": "arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes."
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_domains_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
certificate_id | string | No | — | ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy. |
certificate_management_policy | object | No | — | Certificate Management Policy |
description | string | No | — | human-readable description of what this reserved domain will be used for |
domain | string | No | — | hostname of the reserved domain |
metadata | string | No | — | arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. |
region | string | No | — | deprecated: 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_to | object[] | No | — | DNS resolver targets configured for the reserved domain, or empty for “global” resolution. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_id": {
"type": "string",
"description": "ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with `certificate_management_policy`."
},
"certificate_management_policy": {
"type": "object",
"description": "Certificate Management Policy",
"properties": {
"authority": {
"type": "string",
"description": "certificate authority to request certificates from. The only supported value is letsencrypt."
},
"private_key_type": {
"type": "string",
"description": "type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa."
}
}
},
"description": {
"type": "string",
"description": "human-readable description of what this reserved domain will be used for"
},
"domain": {
"type": "string",
"description": "hostname of the reserved domain"
},
"metadata": {
"type": "string",
"description": "arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes."
},
"region": {
"type": "string",
"description": "deprecated: 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_to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "accepts an ngrok point-of-presence shortcode, or \"global\""
}
}
},
"description": "DNS resolver targets configured for the reserved domain, or empty for \"global\" resolution."
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_reserved_domains_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_domains_delete_certificate
DeleteCertificate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_domains_delete_certificate_management_policy
DeleteCertificateManagementPolicy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_domains_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_reserved_domains_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before_id | string | No | — | Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. |
limit | string | No | — | Constrains the number of results in the dataset. See the API Overview for details. |
filter | string | No | — | A 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before_id": {
"type": "string",
"description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
},
"limit": {
"type": "string",
"description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
},
"filter": {
"type": "string",
"description": "A 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."
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_reserved_domains_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
certificate_id | string | No | — | ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy. |
certificate_management_policy | object | No | — | Certificate Management Policy |
description | string | No | — | human-readable description of what this reserved domain will be used for |
metadata | string | No | — | arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. |
resolves_to | object[] | No | — | DNS resolver targets configured for the reserved domain, or empty for “global” resolution. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"certificate_id": {
"type": "string",
"description": "ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with `certificate_management_policy`."
},
"certificate_management_policy": {
"type": "object",
"description": "Certificate Management Policy",
"properties": {
"authority": {
"type": "string",
"description": "certificate authority to request certificates from. The only supported value is letsencrypt."
},
"private_key_type": {
"type": "string",
"description": "type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa."
}
}
},
"description": {
"type": "string",
"description": "human-readable description of what this reserved domain will be used for"
},
"metadata": {
"type": "string",
"description": "arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes."
},
"resolves_to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "accepts an ngrok point-of-presence shortcode, or \"global\""
}
}
},
"description": "DNS resolver targets configured for the reserved domain, or empty for \"global\" resolution."
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_tunnel_sessions_get
Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_tunnel_sessions_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
before_id | string | No | — | Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. |
limit | string | No | — | Constrains the number of results in the dataset. See the API Overview for details. |
filter | string | No | — | A 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"before_id": {
"type": "string",
"description": "Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID."
},
"limit": {
"type": "string",
"description": "Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details."
},
"filter": {
"type": "string",
"description": "A 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."
}
},
"required": [
"PCID"
]
}
ngrok_tunnels_tunnel_sessions_restart
Restart Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_tunnel_sessions_stop
Stop Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | a resource identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "a resource identifier"
}
},
"required": [
"PCID",
"id"
]
}
ngrok_tunnels_tunnel_sessions_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}