{ "opencollection": "1.0.0", "info": { "name": "Ngrok API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Abuse Reports", "type": "folder" }, "items": [ { "info": { "name": "Ngrok Create Abuse Report", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/abuse_reports", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new abuse report which will be reviewed by our system and abuse response team." }, { "info": { "name": "Ngrok Get Abuse Report", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/abuse_reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the detailed status of an abuse report by ID." } ] }, { "info": { "name": "Agent Ingresses", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Agent Ingresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/agent_ingresses", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Agent Ingresses." }, { "info": { "name": "Ngrok Create Agent Ingress", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/agent_ingresses", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Agent Ingress." }, { "info": { "name": "Ngrok Get Agent Ingress", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/agent_ingresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an Agent Ingress by ID." }, { "info": { "name": "Ngrok Update Agent Ingress", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/agent_ingresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an Agent Ingress by ID." }, { "info": { "name": "Ngrok Delete Agent Ingress", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/agent_ingresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an Agent Ingress by ID." } ] }, { "info": { "name": "API Keys", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List API Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/api_keys", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all API keys on this account." }, { "info": { "name": "Ngrok Create API Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/api_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new API key." }, { "info": { "name": "Ngrok Get API Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/api_keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an API key by ID." }, { "info": { "name": "Ngrok Update API Key", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/api_keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an API key by ID." }, { "info": { "name": "Ngrok Delete API Key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/api_keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an API key by ID." } ] }, { "info": { "name": "Certificate Authorities", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Certificate Authorities", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/certificate_authorities", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Certificate Authorities on this account." }, { "info": { "name": "Ngrok Create Certificate Authority", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/certificate_authorities", "body": { "type": "json", "data": "{}" } }, "docs": "Upload a new Certificate Authority." }, { "info": { "name": "Ngrok Get Certificate Authority", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/certificate_authorities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a Certificate Authority by ID." }, { "info": { "name": "Ngrok Update Certificate Authority", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/certificate_authorities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of a Certificate Authority by ID." }, { "info": { "name": "Ngrok Delete Certificate Authority", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/certificate_authorities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a Certificate Authority by ID." } ] }, { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/credentials", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all tunnel authtoken credentials on this account." }, { "info": { "name": "Ngrok Create Credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/credentials", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tunnel authtoken credential." }, { "info": { "name": "Ngrok Get Credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a tunnel authtoken credential by ID." }, { "info": { "name": "Ngrok Update Credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of a tunnel authtoken credential by ID." }, { "info": { "name": "Ngrok Delete Credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a tunnel authtoken credential by ID." } ] }, { "info": { "name": "Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/endpoints", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all active endpoints on the account." }, { "info": { "name": "Ngrok Create Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/endpoints", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new endpoint." }, { "info": { "name": "Ngrok Get Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/endpoints/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an endpoint by ID." }, { "info": { "name": "Ngrok Update Endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/endpoints/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an endpoint by ID." }, { "info": { "name": "Ngrok Delete Endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/endpoints/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an endpoint by ID." } ] }, { "info": { "name": "Event Destinations", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Event Destinations", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/event_destinations", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Event Destinations on this account." }, { "info": { "name": "Ngrok Create Event Destination", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/event_destinations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Event Destination." }, { "info": { "name": "Ngrok Get Event Destination", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/event_destinations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an Event Destination by ID." }, { "info": { "name": "Ngrok Update Event Destination", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/event_destinations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an Event Destination by ID." }, { "info": { "name": "Ngrok Delete Event Destination", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/event_destinations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an Event Destination by ID." } ] }, { "info": { "name": "Event Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Event Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/event_subscriptions", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Event Subscriptions on this account." }, { "info": { "name": "Ngrok Create Event Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/event_subscriptions", "body": { "type": "json", "data": "{}" } }, "docs": "Create an Event Subscription." }, { "info": { "name": "Ngrok Get Event Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/event_subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get an Event Subscription by ID." }, { "info": { "name": "Ngrok Update Event Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/event_subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Event Subscription by ID." }, { "info": { "name": "Ngrok Delete Event Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/event_subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an Event Subscription by ID." } ] }, { "info": { "name": "IP Policies", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List IP Policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ip_policies", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all IP policies on this account." }, { "info": { "name": "Ngrok Create IP Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ip_policies", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new IP policy." }, { "info": { "name": "Ngrok Get IP Policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ip_policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an IP policy by ID." }, { "info": { "name": "Ngrok Update IP Policy", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ip_policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an IP policy by ID." }, { "info": { "name": "Ngrok Delete IP Policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ip_policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an IP policy by ID." } ] }, { "info": { "name": "IP Policy Rules", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List IP Policy Rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ip_policy_rules", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all IP policy rules on this account." }, { "info": { "name": "Ngrok Create IP Policy Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ip_policy_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new IP policy rule attached to an IP policy." }, { "info": { "name": "Ngrok Get IP Policy Rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ip_policy_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an IP policy rule by ID." }, { "info": { "name": "Ngrok Update IP Policy Rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ip_policy_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an IP policy rule by ID." }, { "info": { "name": "Ngrok Delete IP Policy Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ip_policy_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an IP policy rule by ID." } ] }, { "info": { "name": "IP Restrictions", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List IP Restrictions", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ip_restrictions", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all IP restrictions on this account." }, { "info": { "name": "Ngrok Create IP Restriction", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ip_restrictions", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new IP restriction." }, { "info": { "name": "Ngrok Get IP Restriction", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ip_restrictions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an IP restriction by ID." }, { "info": { "name": "Ngrok Update IP Restriction", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ip_restrictions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an IP restriction by ID." }, { "info": { "name": "Ngrok Delete IP Restriction", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ip_restrictions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an IP restriction by ID." } ] }, { "info": { "name": "Reserved Addresses", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Reserved Addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/reserved_addrs", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all reserved addresses on this account." }, { "info": { "name": "Ngrok Create Reserved Address", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/reserved_addrs", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new reserved address." }, { "info": { "name": "Ngrok Get Reserved Address", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/reserved_addrs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a reserved address by ID." }, { "info": { "name": "Ngrok Update Reserved Address", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/reserved_addrs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of a reserved address by ID." }, { "info": { "name": "Ngrok Delete Reserved Address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/reserved_addrs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a reserved address by ID." } ] }, { "info": { "name": "Reserved Domains", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Reserved Domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/reserved_domains", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all reserved domains on this account." }, { "info": { "name": "Ngrok Create Reserved Domain", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/reserved_domains", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new reserved domain." }, { "info": { "name": "Ngrok Get Reserved Domain", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/reserved_domains/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a reserved domain by ID." }, { "info": { "name": "Ngrok Update Reserved Domain", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/reserved_domains/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of a reserved domain by ID." }, { "info": { "name": "Ngrok Delete Reserved Domain", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/reserved_domains/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a reserved domain by ID." } ] }, { "info": { "name": "SSH Certificate Authorities", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List SSH Certificate Authorities", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_certificate_authorities", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all SSH Certificate Authorities on this account." }, { "info": { "name": "Ngrok Create SSH Certificate Authority", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ssh_certificate_authorities", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new SSH Certificate Authority." }, { "info": { "name": "Ngrok Get SSH Certificate Authority", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_certificate_authorities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an SSH Certificate Authority by ID." }, { "info": { "name": "Ngrok Update SSH Certificate Authority", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ssh_certificate_authorities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an SSH Certificate Authority by ID." }, { "info": { "name": "Ngrok Delete SSH Certificate Authority", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ssh_certificate_authorities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an SSH Certificate Authority by ID." } ] }, { "info": { "name": "SSH Credentials", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List SSH Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_credentials", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all SSH credentials on this account." }, { "info": { "name": "Ngrok Create SSH Credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ssh_credentials", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new SSH credential for authenticating to ngrok tunnels." }, { "info": { "name": "Ngrok Get SSH Credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an SSH credential by ID." }, { "info": { "name": "Ngrok Update SSH Credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ssh_credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of an SSH credential by ID." }, { "info": { "name": "Ngrok Delete SSH Credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ssh_credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an SSH credential by ID." } ] }, { "info": { "name": "SSH Host Certificates", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List SSH Host Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_host_certificates", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all SSH Host Certificates on this account." }, { "info": { "name": "Ngrok Create SSH Host Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ssh_host_certificates", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new SSH Host Certificate." }, { "info": { "name": "Ngrok Get SSH Host Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_host_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an SSH Host Certificate by ID." }, { "info": { "name": "Ngrok Update SSH Host Certificate", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ssh_host_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an SSH Host Certificate by ID." }, { "info": { "name": "Ngrok Delete SSH Host Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ssh_host_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an SSH Host Certificate by ID." } ] }, { "info": { "name": "SSH User Certificates", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List SSH User Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_user_certificates", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all SSH User Certificates on this account." }, { "info": { "name": "Ngrok Create SSH User Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/ssh_user_certificates", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new SSH User Certificate." }, { "info": { "name": "Ngrok Get SSH User Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/ssh_user_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of an SSH User Certificate by ID." }, { "info": { "name": "Ngrok Update SSH User Certificate", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/ssh_user_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an SSH User Certificate by ID." }, { "info": { "name": "Ngrok Delete SSH User Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/ssh_user_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an SSH User Certificate by ID." } ] }, { "info": { "name": "TLS Certificates", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List TLS Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/tls_certificates", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all TLS certificates on this account." }, { "info": { "name": "Ngrok Create TLS Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/tls_certificates", "body": { "type": "json", "data": "{}" } }, "docs": "Upload a new TLS certificate." }, { "info": { "name": "Ngrok Get TLS Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/tls_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a TLS certificate by ID." }, { "info": { "name": "Ngrok Update TLS Certificate", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/tls_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update attributes of a TLS certificate by ID." }, { "info": { "name": "Ngrok Delete TLS Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/tls_certificates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a TLS certificate by ID." } ] }, { "info": { "name": "Tunnel Sessions", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Tunnel Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/tunnel_sessions", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all online tunnel sessions running on this account." }, { "info": { "name": "Ngrok Get Tunnel Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/tunnel_sessions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a tunnel session by ID." }, { "info": { "name": "Ngrok Restart Tunnel Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/tunnel_sessions/:id/restart", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Issues a command to the ngrok agent to restart a tunnel session." }, { "info": { "name": "Ngrok Stop Tunnel Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/tunnel_sessions/:id/stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Issues a command to the ngrok agent to stop a tunnel session." }, { "info": { "name": "Ngrok Update Tunnel Session Agent", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/tunnel_sessions/:id/update", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Issues a command to the ngrok agent to update itself to the latest version." } ] }, { "info": { "name": "Tunnels", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Tunnels", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/tunnels", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all online tunnels currently running on the account." }, { "info": { "name": "Ngrok Get Tunnel", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/tunnels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get the details of a tunnel by ID." } ] }, { "info": { "name": "Edges HTTPS", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List HTTPS Edges", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/edges/https", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all HTTPS Edges on this account." }, { "info": { "name": "Ngrok Create HTTPS Edge", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/edges/https", "body": { "type": "json", "data": "{}" } }, "docs": "Create an HTTPS Edge." }, { "info": { "name": "Ngrok Get HTTPS Edge", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/edges/https/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get an HTTPS Edge by ID." }, { "info": { "name": "Ngrok Update HTTPS Edge", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/edges/https/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an HTTPS Edge by ID." }, { "info": { "name": "Ngrok Delete HTTPS Edge", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/edges/https/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an HTTPS Edge by ID." } ] }, { "info": { "name": "Edges TCP", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List TCP Edges", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/edges/tcp", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all TCP Edges on this account." }, { "info": { "name": "Ngrok Create TCP Edge", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/edges/tcp", "body": { "type": "json", "data": "{}" } }, "docs": "Create a TCP Edge." }, { "info": { "name": "Ngrok Get TCP Edge", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/edges/tcp/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get a TCP Edge by ID." }, { "info": { "name": "Ngrok Update TCP Edge", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/edges/tcp/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a TCP Edge by ID." }, { "info": { "name": "Ngrok Delete TCP Edge", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/edges/tcp/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a TCP Edge by ID." } ] }, { "info": { "name": "Edges TLS", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List TLS Edges", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/edges/tls", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all TLS Edges on this account." }, { "info": { "name": "Ngrok Create TLS Edge", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/edges/tls", "body": { "type": "json", "data": "{}" } }, "docs": "Create a TLS Edge." }, { "info": { "name": "Ngrok Get TLS Edge", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/edges/tls/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get a TLS Edge by ID." }, { "info": { "name": "Ngrok Update TLS Edge", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/edges/tls/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a TLS Edge by ID." }, { "info": { "name": "Ngrok Delete TLS Edge", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/edges/tls/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a TLS Edge by ID." } ] }, { "info": { "name": "Backends", "type": "folder" }, "items": [ { "info": { "name": "Ngrok List Tunnel Group Backends", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/tunnel_group", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Tunnel Group backends on this account." }, { "info": { "name": "Ngrok Create Tunnel Group Backend", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/backends/tunnel_group", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Tunnel Group backend." }, { "info": { "name": "Ngrok Get Tunnel Group Backend", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/tunnel_group/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get a Tunnel Group backend by ID." }, { "info": { "name": "Ngrok Update Tunnel Group Backend", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/backends/tunnel_group/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Tunnel Group backend by ID." }, { "info": { "name": "Ngrok Delete Tunnel Group Backend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/backends/tunnel_group/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a Tunnel Group backend by ID." }, { "info": { "name": "Ngrok List Weighted Backends", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/weighted", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Weighted backends on this account." }, { "info": { "name": "Ngrok Create Weighted Backend", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/backends/weighted", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Weighted backend." }, { "info": { "name": "Ngrok Get Weighted Backend", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/weighted/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get a Weighted backend by ID." }, { "info": { "name": "Ngrok Update Weighted Backend", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/backends/weighted/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Weighted backend by ID." }, { "info": { "name": "Ngrok Delete Weighted Backend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/backends/weighted/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a Weighted backend by ID." }, { "info": { "name": "Ngrok List Failover Backends", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/failover", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Failover backends on this account." }, { "info": { "name": "Ngrok Create Failover Backend", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/backends/failover", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Failover backend." }, { "info": { "name": "Ngrok Get Failover Backend", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/failover/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get a Failover backend by ID." }, { "info": { "name": "Ngrok Update Failover Backend", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/backends/failover/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Failover backend by ID." }, { "info": { "name": "Ngrok Delete Failover Backend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/backends/failover/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a Failover backend by ID." }, { "info": { "name": "Ngrok List HTTP Response Backends", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/http_response", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all HTTP Response backends on this account." }, { "info": { "name": "Ngrok Create HTTP Response Backend", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/backends/http_response", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new HTTP Response backend that returns a static response." }, { "info": { "name": "Ngrok Get HTTP Response Backend", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/http_response/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get an HTTP Response backend by ID." }, { "info": { "name": "Ngrok Update HTTP Response Backend", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/backends/http_response/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an HTTP Response backend by ID." }, { "info": { "name": "Ngrok Delete HTTP Response Backend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/backends/http_response/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete an HTTP Response backend by ID." }, { "info": { "name": "Ngrok List Static Address Backends", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/static_address", "params": [ { "name": "before_id", "value": "", "type": "query", "description": "An ID to use for pagination. Results returned will be before this ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return. Maximum is 100." } ] }, "docs": "List all Static Address backends on this account." }, { "info": { "name": "Ngrok Create Static Address Backend", "type": "http" }, "http": { "method": "POST", "url": "https://api.ngrok.com/backends/static_address", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Static Address backend." }, { "info": { "name": "Ngrok Get Static Address Backend", "type": "http" }, "http": { "method": "GET", "url": "https://api.ngrok.com/backends/static_address/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Get a Static Address backend by ID." }, { "info": { "name": "Ngrok Update Static Address Backend", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.ngrok.com/backends/static_address/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Static Address backend by ID." }, { "info": { "name": "Ngrok Delete Static Address Backend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ngrok.com/backends/static_address/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique identifier for the resource." } ] }, "docs": "Delete a Static Address backend by ID." } ] } ], "bundled": true }