The ngrok connector lets your AI agent act in each user's ngrok account. Each user connects their own ngrok access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 29 · 19 · 1129 read19 write11 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ngrok connection
In AgentKit > Connections, create a ngrok connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'ngrok'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize ngrok:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'ngrok_agent_ingresses_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "ngrok"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize ngrok:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="ngrok_agent_ingresses_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ngrok credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolngrok_agent_ingress_getGet one agent ingress by ID.Read-onlyGet Agent Ingress
Get one agent ingress by ID. Returns the agent ingress with domain, ns_targets, region domains and certificate status. Use this when you know the ID. Use ngrok_agent_ingresses_list to find it.
Inputs
idstringrequired- a resource identifier. Example: agin_2nGsUw4HfJ1vXq3bZt9eL8CkYdR.
ngrok_agent_ingresses_listList agent ingresses in the ngrok account, newest first, optionally filtered.Read-onlyList Agent Ingresses
List agent ingresses in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of agent ingresses with next_page_uri; pass the last ID as before_id for the next page. Use this to browse agent ingresses. Use ngrok_agent_ingress_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, created_at, description, metadata, domain. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_api_key_getGet one api key by ID.Read-onlyGet API Key
Get one api key by ID. Returns the API key with description, metadata and owner (the token itself is not returned). Use this when you know the ID. Use ngrok_api_keys_list to find it.
Inputs
idstringrequired- a resource identifier. Example: ak_2nGsHlBhZxvM4ZfyEtUsUoVZ0bC.
ngrok_api_keys_listList API keys in the ngrok account, newest first, optionally filtered.Read-onlyList API Keys
List API keys in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of API keys with next_page_uri; pass the last ID as before_id for the next page. Use this to browse API keys. Use ngrok_api_key_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, description, metadata, owner_id, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_credential_getGet one credential by ID.Read-onlyGet Credential
Get one credential by ID. Returns the credential with description, metadata, acl and owner (the token itself is not returned). Use this when you know the ID. Use ngrok_credentials_list to find it.
Inputs
idstringrequired- a resource identifier. Example: cr_2nGsF5K8pTUNlzkHCa0BQ1jwpqm.
ngrok_credentials_listList credentials in the ngrok account, newest first, optionally filtered.Read-onlyList Credentials
List credentials in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of credentials with next_page_uri; pass the last ID as before_id for the next page. Use this to browse credentials. Use ngrok_credential_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, description, metadata, owner_id, acl, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_endpoint_getGet one endpoint by ID.Read-onlyGet Endpoint
Get one endpoint by ID. Returns the endpoint with url, type (agent or cloud), proto, traffic_policy, bindings, tunnel or edge reference and timestamps. Use this when you know the ID. Use ngrok_endpoints_list to find it.
Inputs
idstringrequired- a resource identifier. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
ngrok_endpoints_listList endpoints in the ngrok account, newest first, optionally filtered.Read-onlyList Endpoints
List endpoints in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of endpoints with next_page_uri; pass the last ID as before_id for the next page. Use this to browse endpoints. Use ngrok_endpoint_get for one by ID. Agent endpoints started by the ngrok agent appear here too.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, url, type, pooling_enabled, region, scheme, description, metadata, name, created_at, principal.id, bindings. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_event_subscription_getGet one event subscription by ID.Read-onlyGet Event Subscription
Get one event subscription by ID. Returns the subscription with its event sources and destinations. Use this when you know the ID. Use ngrok_event_subscriptions_list to find it.
Inputs
idstringrequired- a resource identifier. Example: esb_2nGsWy7MbQ0rTn5cXv2fH6JpAuL.
ngrok_event_subscriptions_listList event subscriptions in the ngrok account, newest first, optionally filtered.Read-onlyList Event Subscriptions
List event subscriptions in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of event subscriptions with next_page_uri; pass the last ID as before_id for the next page. Use this to browse event subscriptions. Use ngrok_event_subscription_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, description, metadata, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_ip_policies_listList IP policies in the ngrok account, newest first, optionally filtered.Read-onlyList IP Policies
List IP policies in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of IP policies with next_page_uri; pass the last ID as before_id for the next page. Use this to browse IP policies. Use ngrok_ip_policy_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, created_at, description, metadata, name. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_ip_policy_getGet one ip policy by ID.Read-onlyGet IP Policy
Get one ip policy by ID. Returns the IP policy with description and metadata. Use this when you know the ID. Use ngrok_ip_policies_list to find it.
Inputs
idstringrequired- a resource identifier. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.
ngrok_ip_policy_rule_getGet one ip policy rule by ID.Read-onlyGet IP Policy Rule
Get one ip policy rule by ID. Returns the rule with cidr, action (allow or deny) and its IP policy. Use this when you know the ID. Use ngrok_ip_policy_rules_list to find it.
Inputs
idstringrequired- a resource identifier. Example: ipr_2nGsLr2wKz9xBHsDy4sq3G1KQ8N.
ngrok_ip_policy_rules_listList IP policy rules in the ngrok account, newest first, optionally filtered.Read-onlyList IP Policy Rules
List IP policy rules in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of IP policy rules with next_page_uri; pass the last ID as before_id for the next page. Use this to browse IP policy rules. Use ngrok_ip_policy_rule_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, created_at, description, metadata, cidr, ip_policy_id, action. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_reserved_addr_getGet one reserved addr by ID.Read-onlyGet Reserved Addr
Get one reserved addr by ID. Returns the address with addr, region, description and metadata. Use this when you know the ID. Use ngrok_reserved_addrs_list to find it.
Inputs
idstringrequired- a resource identifier. Example: ra_2nGsDAvKqSzR3pnmQ5UuPeC8xKW.
ngrok_reserved_addrs_listList reserved addrs in the ngrok account, newest first, optionally filtered.Read-onlyList Reserved Addrs
List reserved addrs in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of reserved addrs with next_page_uri; pass the last ID as before_id for the next page. Use this to browse reserved addrs. Use ngrok_reserved_addr_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, description, metadata, addr, region, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_reserved_domain_getGet one reserved domain by ID.Read-onlyGet Reserved Domain
Get one reserved domain by ID. Returns the domain with its cname_target, certificate, certificate management status and timestamps. Use this when you know the ID. Use ngrok_reserved_domains_list to find it.
Inputs
idstringrequired- a resource identifier. Example: rd_2nGsBQ0MpQe1Fz9QYQZkAaHxP3T.
ngrok_reserved_domains_listList reserved domains in the ngrok account, newest first, optionally filtered.Read-onlyList Reserved Domains
List reserved domains in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of reserved domains with next_page_uri; pass the last ID as before_id for the next page. Use this to browse reserved domains. Use ngrok_reserved_domain_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, description, metadata, domain, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_service_users_listList service users in the ngrok account, newest first, optionally filtered.Read-onlyList Service Users
List service users in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of service users with next_page_uri; pass the last ID as before_id for the next page. Use this to browse service users. Use ngrok_service_user_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, name, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_tls_certificate_getGet one tls certificate by ID.Read-onlyGet TLS Certificate
Get one tls certificate by ID. Returns the certificate with subject names, issuer, validity dates and key type. Use this when you know the ID. Use ngrok_tls_certificates_list to find it.
Inputs
idstringrequired- a resource identifier. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.
ngrok_tls_certificates_listList TLS certificates in the ngrok account, newest first, optionally filtered.Read-onlyList TLS Certificates
List TLS certificates in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of TLS certificates with next_page_uri; pass the last ID as before_id for the next page. Use this to browse TLS certificates. Use ngrok_tls_certificate_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, description, metadata, subject_common_name, not_before, not_after, serial_number, created_at. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_tunnel_getGet one online tunnel by ID.Read-onlyGet Tunnel
Get one online tunnel by ID. Returns the tunnel with public_url, proto, region, forwards_to and its tunnel session. Use this when you know the ID.
Inputs
idstringrequired- a resource identifier. Example: tn_2nGrd6WYdnbo8T7JAt4UzLsX1QB.
ngrok_tunnel_session_getGet one online agent session by ID.Read-onlyGet Tunnel Session
Get one online agent session by ID. Returns the session with agent version, IP, OS, region and credential. Use this when you know the ID.
Inputs
idstringrequired- a resource identifier. Example: ts_2nGrd4lKFkXyrHm9AcCzfVuIqjP.
ngrok_tunnel_sessions_listList online ngrok agent sessions.Read-onlyList Tunnel Sessions
List online ngrok agent sessions. Returns sessions with id, agent_version, ip, os, region, credential and started_at. Use this to see which agents are connected. Use ngrok_tunnels_list for what they expose.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, metadata, agent_version, ip, os, region, started_at, credential. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_tunnels_listList the tunnels currently online in the account (one per agent endpoint or tunnel).Read-onlyList Tunnels
List the tunnels currently online in the account (one per agent endpoint or tunnel). Returns tunnels with id, public_url, proto, region, tunnel_session, forwards_to and started_at. Use this to see what agents are exposing now. Use ngrok_tunnel_sessions_list for the agent sessions.
Inputs
before_idstring- before id. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
limitstring- limit. Example: 25.
ngrok_vault_getGet one vault by ID.Read-onlyGet Vault
Get one vault by ID. Returns the vault with name, description and metadata. Use this when you know the ID. Use ngrok_vaults_list to find it.
Inputs
idstringrequired- a resource identifier. Example: vault_2nGsNy0pLx8YqCkWrj5d5M3H0aT.
ngrok_vault_secret_getGet one secret's metadata by ID.Read-onlyGet Vault Secret
Get one secret's metadata by ID. Returns the secret's name, vault, description and metadata (not its value). Use this when you know the ID.
Inputs
idstringrequired- a resource identifier. Example: secret_2nGsQ1sZ6mKdXo8rPm4wTbF5yHc.
ngrok_vault_secrets_listList secrets across all vaults (names and metadata only, never values).Read-onlyList Vault Secrets
List secrets across all vaults (names and metadata only, never values). filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of secrets with next_page_uri; pass the last ID as before_id for the next page. Use this to browse secrets. Use ngrok_vault_secret_get for one.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, created_at, description, metadata, name. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_vaults_listList vaults in the ngrok account, newest first, optionally filtered.Read-onlyList Vaults
List vaults in the ngrok account, newest first, optionally filtered. filter is a CEL expression over obj, e.g. obj.metadata.contains('prod'). Returns a page of vaults with next_page_uri; pass the last ID as before_id for the next page. Use this to browse vaults. Use ngrok_vault_get for one by ID.
Inputs
before_idstring- Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
filterstring- 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. Filterable fields: id, created_at, description, metadata, name. Example: obj.metadata.contains('sk-test')
limitstring- Constrains the number of results in the dataset. See the API Overview (https://ngrok.com/docs/api/index#pagination) for details. Example: 25.
ngrok_api_key_createCreate an API key; the token is returned only in this response.WriteCreate API Key
Create an API key; the token is returned only in this response. Returns the created api key. Use ngrok_api_key_update to change it later.
Inputs
descriptionstring- human-readable description of what uses the API key to authenticate. optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined data of this API key. optional, max 4096 bytes. Example: {"owner":"platform-team"}
owner_idstring- If 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. Example: usr_2nGsdF3RdV7wXr9gBz8jO3PtDyQ.
ngrok_api_key_updateUpdate the editable fields of one api key; fields you leave out are unchanged.WriteUpdate API Key
Update the editable fields of one api key; fields you leave out are unchanged. Returns the updated api key. Use this to edit. Use ngrok_api_key_create to add a new one.
Inputs
idstringrequired- ID of the api key. Example: ak_2nGsHlBhZxvM4ZfyEtUsUoVZ0bC.
descriptionstring- human-readable description of what uses the API key to authenticate. optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined data of this API key. optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_credential_createCreate a tunnel credential (authtoken) for the ngrok agent, optionally limited by ACL rules such as bind:<domain>; the token is returned only in this response.WriteCreate Credential
Create a tunnel credential (authtoken) for the ngrok agent, optionally limited by ACL rules such as bind:<domain>; the token is returned only in this response. Returns the created credential. Use ngrok_credential_update to change it later.
Inputs
aclarray- optional 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. Example: ["bind:sk-test-api.ngrok.app"]
descriptionstring- human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
owner_idstring- If 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. Example: usr_2nGsdF3RdV7wXr9gBz8jO3PtDyQ.
ngrok_credential_updateUpdate the editable fields of one credential; fields you leave out are unchanged.WriteUpdate Credential
Update the editable fields of one credential; fields you leave out are unchanged. Returns the updated credential. Use this to edit. Use ngrok_credential_create to add a new one.
Inputs
idstringrequired- ID of the credential. Example: cr_2nGsF5K8pTUNlzkHCa0BQ1jwpqm.
aclarray- optional 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. Example: ["bind:sk-test-api.ngrok.app"]
descriptionstring- human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_endpoint_createCreate a cloud endpoint: a public or internal URL whose traffic is handled entirely by a Traffic Policy (YAML or JSON).WriteCreate Endpoint
Create a cloud endpoint: a public or internal URL whose traffic is handled entirely by a Traffic Policy (YAML or JSON). Returns the created endpoint. Use ngrok_endpoint_update to change it later.
Inputs
traffic_policystringrequired- The Traffic Policy attached to this endpoint. Example: {"on_http_request":[{"actions":[{"type":"forward-internal","config":{"url":"https://api.internal"}}]}]}
typestringrequired- Type of endpoint. Only 'cloud' is currently supported (represents a Cloud Endpoint). Defaults to 'cloud' if not specified. Example: cloud.
urlstringrequired- the url of the endpoint. Example: https://sk-test-api.ngrok.app.
bindingsarray- the bindings associated with this endpoint. Example: ["public"]
descriptionstring- user-supplied description of the associated tunnel. Example: sk-test staging API.
metadatastring- user-supplied metadata of the associated tunnel or edge object. Example: {"owner":"platform-team"}
pooling_enabledboolean- n/a. Example: true.
ngrok_endpoint_updateUpdate the editable fields of one endpoint; fields you leave out are unchanged.WriteUpdate Endpoint
Update the editable fields of one endpoint; fields you leave out are unchanged. Returns the updated endpoint. Use this to edit. Use ngrok_endpoint_create to add a new one.
Inputs
idstringrequired- ID of the endpoint. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
bindingsarray- the bindings associated with this endpoint. Example: ["public"]
descriptionstring- user-supplied description of the associated tunnel. Example: sk-test staging API.
metadatastring- user-supplied metadata of the associated tunnel or edge object. Example: {"owner":"platform-team"}
pooling_enabledboolean- n/a. Example: true.
traffic_policystring- The Traffic Policy attached to this endpoint. Example: {"on_http_request":[{"actions":[{"type":"forward-internal","config":{"url":"https://api.internal"}}]}]}
urlstring- the url of the endpoint. Example: https://sk-test-api.ngrok.app.
ngrok_ip_policy_createCreate an IP policy: a named set of allow and deny CIDR rules used by IP restrictions and traffic policies.WriteCreate IP Policy
Create an IP policy: a named set of allow and deny CIDR rules used by IP restrictions and traffic policies. Returns the created ip policy. Use ngrok_ip_policy_update to change it later.
Inputs
descriptionstring- human-readable description of the source IPs of this IP policy. optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_ip_policy_rule_createCreate an IP policy rule that allows or denies one CIDR in an IP policy.WriteCreate IP Policy Rule
Create an IP policy rule that allows or denies one CIDR in an IP policy. Returns the created ip policy rule. Use ngrok_ip_policy_rule_update to change it later.
Inputs
actionstringrequired- the action to apply to the policy rule, either allow or deny. Example: allow.
cidrstringrequired- an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported. Example: 203.0.113.0/24.
ip_policy_idstringrequired- ID of the IP policy this IP policy rule will be attached to. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.
descriptionstring- human-readable description of the source IPs of this IP rule. optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_ip_policy_rule_updateUpdate the editable fields of one ip policy rule; fields you leave out are unchanged.WriteUpdate IP Policy Rule
Update the editable fields of one ip policy rule; fields you leave out are unchanged. Returns the updated ip policy rule. Use this to edit. Use ngrok_ip_policy_rule_create to add a new one.
Inputs
idstringrequired- ID of the ip policy rule. Example: ipr_2nGsLr2wKz9xBHsDy4sq3G1KQ8N.
cidrstring- an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported. Example: 203.0.113.0/24.
descriptionstring- human-readable description of the source IPs of this IP rule. optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_ip_policy_updateUpdate the editable fields of one ip policy; fields you leave out are unchanged.WriteUpdate IP Policy
Update the editable fields of one ip policy; fields you leave out are unchanged. Returns the updated ip policy. Use this to edit. Use ngrok_ip_policy_create to add a new one.
Inputs
idstringrequired- ID of the ip policie. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.
descriptionstring- human-readable description of the source IPs of this IP policy. optional, max 255 bytes. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_reserved_addr_createCreate a reserved TCP address (host:port) in a region, for TCP endpoints.WriteCreate Reserved Addr
Create a reserved TCP address (host:port) in a region, for TCP endpoints. Returns the created reserved addr. Use ngrok_reserved_addr_update to change it later.
Inputs
descriptionstring- human-readable description of what this reserved address will be used for. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
regionstring- reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa). Example: us.
ngrok_reserved_addr_updateUpdate the editable fields of one reserved addr; fields you leave out are unchanged.WriteUpdate Reserved Addr
Update the editable fields of one reserved addr; fields you leave out are unchanged. Returns the updated reserved addr. Use this to edit. Use ngrok_reserved_addr_create to add a new one.
Inputs
idstringrequired- ID of the reserved addr. Example: ra_2nGsDAvKqSzR3pnmQ5UuPeC8xKW.
descriptionstring- human-readable description of what this reserved address will be used for. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
ngrok_reserved_domain_createCreate a reserved domain: an ngrok subdomain or your own domain (CNAME it to the returned target) with optional certificate settings.WriteCreate Reserved Domain
Create a reserved domain: an ngrok subdomain or your own domain (CNAME it to the returned target) with optional certificate settings. Returns the created reserved domain. Use ngrok_reserved_domain_update to change it later.
Inputs
certificate_idstring- ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.
certificate_management_policyobject- configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id. Example: {"authority":"letsencrypt","private_key_type":"ecdsa"}
descriptionstring- human-readable description of what this reserved domain will be used for. Example: sk-test staging API.
domainstring- hostname of the reserved domain. Example: sk-test-api.example.com.
metadatastring- arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
regionstring- 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). Example: us.
resolves_toarray- Region and IP resolution targets configured for the Domain. Example: [{"value":"global"}]
ngrok_reserved_domain_updateUpdate the editable fields of one reserved domain; fields you leave out are unchanged.WriteUpdate Reserved Domain
Update the editable fields of one reserved domain; fields you leave out are unchanged. Returns the updated reserved domain. Use this to edit. Use ngrok_reserved_domain_create to add a new one.
Inputs
idstringrequired- ID of the reserved domain. Example: rd_2nGsBQ0MpQe1Fz9QYQZkAaHxP3T.
certificate_idstring- ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.
certificate_management_policyobject- configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id. Example: {"authority":"letsencrypt","private_key_type":"ecdsa"}
descriptionstring- human-readable description of what this reserved domain will be used for. Example: sk-test staging API.
metadatastring- arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. Example: {"owner":"platform-team"}
resolves_toarray- Region and IP resolution targets configured for the Domain. Example: [{"value":"global"}]
ngrok_tunnel_session_restartAsk an agent to restart its process (agent 2.x and later).WriteRestart Tunnel Session
Ask an agent to restart its process (agent 2.x and later). Returns an empty response once the request is sent. Use this to restart a remote agent. Use ngrok_tunnel_session_stop to shut it down.
Inputs
idstringrequired- ID of the tunnel session. Example: ts_2nGrd4lKFkXyrHm9AcCzfVuIqjP.
ngrok_tunnel_session_stopAsk an agent to stop its process and disconnect.WriteStop Tunnel Session
Ask an agent to stop its process and disconnect. Returns an empty response once the request is sent. Use this to take an agent offline. Use ngrok_tunnel_session_restart to restart it instead.
Inputs
idstringrequired- ID of the tunnel session. Example: ts_2nGrd4lKFkXyrHm9AcCzfVuIqjP.
ngrok_vault_createCreate a secrets vault that holds secrets referenced from traffic policies.WriteCreate Vault
Create a secrets vault that holds secrets referenced from traffic policies. Returns the created vault. Use ngrok_vault_update to change it later.
Inputs
descriptionstring- description of Vault. Example: sk-test staging API.
metadatastring- Arbitrary user-defined metadata for this Vault. Example: {"owner":"platform-team"}
namestring- Name of vault. Example: sk-test-secrets.
ngrok_vault_secret_createCreate a secret in a vault, identified by vault_id or vault_name.WriteCreate Vault Secret
Create a secret in a vault, identified by vault_id or vault_name. Returns the created secret without its value. Use ngrok_vault_secret_update to rotate the value.
Inputs
descriptionstring- description of Secret. Example: sk-test staging API.
metadatastring- Arbitrary user-defined metadata for this Secret. Example: {"owner":"platform-team"}
namestring- Name of secret. Example: sk-test-secrets.
valuestring- Value of secret. Example: s3cr3t-value.
vault_idstring- unique identifier of the referenced vault. Example: vault_2nGsNy0pLx8YqCkWrj5d5M3H0aT.
vault_namestring- name of the referenced vault. Example: sk-test-secrets.
ngrok_vault_secret_updateUpdate a secret's name, value, description or metadata.WriteUpdate Vault Secret
Update a secret's name, value, description or metadata. Returns the updated secret without its value. Use this to rotate a secret.
Inputs
idstringrequired- ID of the vault secret. Example: secret_2nGsQ1sZ6mKdXo8rPm4wTbF5yHc.
descriptionstring- description of Secret. Example: sk-test staging API.
metadatastring- Arbitrary user-defined metadata for this Secret. Example: {"owner":"platform-team"}
namestring- Name of secret. Example: sk-test-secrets.
valuestring- Value of secret. Example: s3cr3t-value.
ngrok_api_key_deletePermanently delete one api key by ID.DestructiveDelete API Key
Permanently delete one api key by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: ak_2nGsHlBhZxvM4ZfyEtUsUoVZ0bC.
ngrok_credential_deletePermanently delete one credential by ID.DestructiveDelete Credential
Permanently delete one credential by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: cr_2nGsF5K8pTUNlzkHCa0BQ1jwpqm.
ngrok_endpoint_deletePermanently delete one endpoint by ID.DestructiveDelete Endpoint
Permanently delete one endpoint by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: ep_2nGs6EdcBNoD0eNMQnVJBUyXN4l.
ngrok_event_subscription_deletePermanently delete one event subscription by ID.DestructiveDelete Event Subscription
Permanently delete one event subscription by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: esb_2nGsWy7MbQ0rTn5cXv2fH6JpAuL.
ngrok_ip_policy_deletePermanently delete one ip policy by ID.DestructiveDelete IP Policy
Permanently delete one ip policy by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: ipp_2nGsJq3ZR5rHPZEanoLbPjq7Ozt.
ngrok_ip_policy_rule_deletePermanently delete one ip policy rule by ID.DestructiveDelete IP Policy Rule
Permanently delete one ip policy rule by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: ipr_2nGsLr2wKz9xBHsDy4sq3G1KQ8N.
ngrok_reserved_addr_deletePermanently delete one reserved addr by ID.DestructiveDelete Reserved Addr
Permanently delete one reserved addr by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: ra_2nGsDAvKqSzR3pnmQ5UuPeC8xKW.
ngrok_reserved_domain_deletePermanently delete one reserved domain by ID.DestructiveDelete Reserved Domain
Permanently delete one reserved domain by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: rd_2nGsBQ0MpQe1Fz9QYQZkAaHxP3T.
ngrok_tls_certificate_deletePermanently delete one tls certificate by ID.DestructiveDelete TLS Certificate
Permanently delete one tls certificate by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: cert_2nGsSv9Kp2wq7RgZLwNjU0TfBzE.
ngrok_vault_deletePermanently delete one vault by ID.DestructiveDelete Vault
Permanently delete one vault by ID. Returns an empty response on success. Use this to remove it; it cannot be undone.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: vault_2nGsNy0pLx8YqCkWrj5d5M3H0aT.
ngrok_vault_secret_deletePermanently delete a secret.DestructiveDelete Vault Secret
Permanently delete a secret. Returns an empty response on success. Use this to remove a secret; traffic policies that reference it will fail.
- Idempotent
Inputs
idstringrequired- a resource identifier. Example: secret_2nGsQ1sZ6mKdXo8rPm4wTbF5yHc.
No tools match.