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

Tools

ToolDescription
ngrok_access_api_keys_createCreate
ngrok_access_api_keys_deleteDelete
ngrok_access_api_keys_getGet
ngrok_access_api_keys_listList
ngrok_access_api_keys_updateUpdate
ngrok_access_application_sessions_deleteDelete
ngrok_access_application_sessions_getGet
ngrok_access_application_sessions_listList
ngrok_access_application_users_deleteDelete
ngrok_access_application_users_getGet
ngrok_access_application_users_listList
ngrok_access_bot_users_createCreate
ngrok_access_bot_users_deleteDelete
ngrok_access_bot_users_getGet
ngrok_access_bot_users_listList
ngrok_access_bot_users_updateUpdate
ngrok_access_credentials_createCreate
ngrok_access_credentials_deleteDelete
ngrok_access_credentials_getGet
ngrok_access_credentials_listList
ngrok_access_credentials_updateUpdate
ngrok_access_ip_policies_createCreate
ngrok_access_ip_policies_deleteDelete
ngrok_access_ip_policies_getGet
ngrok_access_ip_policies_listList
ngrok_access_ip_policies_updateUpdate
ngrok_access_ip_policy_rules_createCreate
ngrok_access_ip_policy_rules_deleteDelete
ngrok_access_ip_policy_rules_getGet
ngrok_access_ip_policy_rules_listList
ngrok_access_ip_policy_rules_updateUpdate
ngrok_access_ip_restrictions_createCreate
ngrok_access_ip_restrictions_deleteDelete
ngrok_access_ip_restrictions_getGet
ngrok_access_ip_restrictions_listList
ngrok_access_ip_restrictions_updateUpdate
ngrok_access_service_users_createCreate
ngrok_access_service_users_deleteDelete
ngrok_access_service_users_getGet
ngrok_access_service_users_listList
ngrok_access_service_users_updateUpdate

ngrok_access_api_keys_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNohuman-readable description of what uses the API key to authenticate. optional, max 255 bytes.
metadatastringNoarbitrary user-defined data of this API key. optional, max 4096 bytes
owner_idstringNoIf supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

ngrok_access_api_keys_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_api_keys_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_api_keys_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_access_api_keys_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
descriptionstringNohuman-readable description of what uses the API key to authenticate. optional, max 255 bytes.
metadatastringNoarbitrary user-defined data of this API key. optional, max 4096 bytes

ngrok_access_application_sessions_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_application_sessions_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_application_sessions_list

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

ngrok_access_application_users_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_application_users_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_application_users_list

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

ngrok_access_bot_users_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNowhether or not the bot is active
namestringNohuman-readable name used to identify the bot

ngrok_access_bot_users_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_bot_users_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_bot_users_list

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

ngrok_access_bot_users_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
activebooleanNowhether or not the bot is active
namestringNohuman-readable name used to identify the bot

ngrok_access_credentials_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
aclstring[]Nooptional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
descriptionstringNohuman-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
metadatastringNoarbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
owner_idstringNoIf supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.

ngrok_access_credentials_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_credentials_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_credentials_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_access_credentials_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
aclstring[]Nooptional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
descriptionstringNohuman-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
metadatastringNoarbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.

ngrok_access_ip_policies_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNohuman-readable description of the source IPs of this IP policy. optional, max 255 bytes.
metadatastringNoarbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

ngrok_access_ip_policies_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_ip_policies_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_ip_policies_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_access_ip_policies_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
descriptionstringNohuman-readable description of the source IPs of this IP policy. optional, max 255 bytes.
metadatastringNoarbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

ngrok_access_ip_policy_rules_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesthe action to apply to the policy rule, either allow or deny
cidrstringYesan IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
descriptionstringNohuman-readable description of the source IPs of this IP rule. optional, max 255 bytes.
ip_policy_idstringYesID of the IP policy this IP policy rule will be attached to
metadatastringNoarbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.

ngrok_access_ip_policy_rules_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_ip_policy_rules_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_ip_policy_rules_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_access_ip_policy_rules_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
cidrstringNoan IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
descriptionstringNohuman-readable description of the source IPs of this IP rule. optional, max 255 bytes.
metadatastringNoarbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.

ngrok_access_ip_restrictions_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNohuman-readable description of this IP restriction. optional, max 255 bytes.
enforcedbooleanNotrue if the IP restriction will be enforced. if false, only warnings will be issued
ip_policy_idsstring[]Yesthe set of IP policy identifiers that are used to enforce the restriction
metadatastringNoarbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
typestringYesthe type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints

ngrok_access_ip_restrictions_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_ip_restrictions_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_ip_restrictions_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_access_ip_restrictions_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
descriptionstringNohuman-readable description of this IP restriction. optional, max 255 bytes.
enforcedbooleanNotrue if the IP restriction will be enforced. if false, only warnings will be issued
ip_policy_idsstring[]Nothe set of IP policy identifiers that are used to enforce the restriction
metadatastringNoarbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.

ngrok_access_service_users_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNowhether or not the service is active
namestringNohuman-readable name used to identify the service

ngrok_access_service_users_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_service_users_get

Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesa resource identifier

ngrok_access_service_users_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_access_service_users_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
activebooleanNowhether or not the service is active
namestringNohuman-readable name used to identify the service