@@ -190,7 +192,7 @@
@propertydefabuse_reports(self)->AbuseReportsClient:
- """Abuse Reports allow you to submit take-down requests for URLs hosted by
+"""Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service."""returnAbuseReportsClient(self)
@@ -200,16 +202,24 @@
@propertydefapi_keys(self)->APIKeysClient:
- """API Keys are used to authenticate to the `ngrok
- API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
+"""API Keys are used to authenticate to the `ngrok
+ API <https://ngrok.com/docs/api#authentication>`_. You may use the API itself to provision and manage API Keys but you'll need to provision your first API
- key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your
+ key from the `API Keys page <https://dashboard.ngrok.com/api/keys>`_ on your ngrok.com dashboard."""returnAPIKeysClient(self)
+ @property
+ defapplication_sessions(self)->ApplicationSessionsClient:
+ returnApplicationSessionsClient(self)
+
+ @property
+ defapplication_users(self)->ApplicationUsersClient:
+ returnApplicationUsersClient(self)
+
@propertydefcertificate_authorities(self)->CertificateAuthoritiesClient:
- """Certificate Authorities are x509 certificates that are used to sign other
+"""Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and
@@ -218,7 +228,7 @@
@propertydefcredentials(self)->CredentialsClient:
- """Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
+"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ``ngrok config add-authtoken`` command or by specifying it in the ``ngrok.yml`` configuration file with the ``authtoken`` property."""
@@ -226,7 +236,7 @@
@propertydefendpoints(self)->EndpointsClient:
- """Endpoints provides an API for querying the endpoint objects
+"""Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned."""returnEndpointsClient(self)
@@ -245,7 +255,7 @@
@propertydefip_policies(self)->IPPoliciesClient:
- """IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``
+"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny`` action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard."""
@@ -253,13 +263,13 @@
@propertydefip_policy_rules(self)->IPPolicyRulesClient:
- """IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy."""returnIPPolicyRulesClient(self)@propertydefip_restrictions(self)->IPRestrictionsClient:
- """An IP restriction is a restriction placed on the CIDRs that are allowed to
+"""An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API
@@ -269,14 +279,14 @@
@propertydefreserved_addrs(self)->ReservedAddrsClient:
- """Reserved Addresses are TCP addresses that can be used to listen for traffic.
+"""Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen."""returnReservedAddrsClient(self)@propertydefreserved_domains(self)->ReservedDomainsClient:
- """Reserved Domains are hostnames that you can listen for traffic on. Domains
+"""Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers."""
@@ -284,33 +294,33 @@
@propertydefssh_certificate_authorities(self)->SSHCertificateAuthoritiesClient:
- """An SSH Certificate Authority is a pair of an SSH Certificate and its private
+"""An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates."""returnSSHCertificateAuthoritiesClient(self)@propertydefssh_credentials(self)->SSHCredentialsClient:
- """SSH Credentials are SSH public keys that can be used to start SSH tunnels
+"""SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway."""returnSSHCredentialsClient(self)@propertydefssh_host_certificates(self)->SSHHostCertificatesClient:
- """SSH Host Certificates along with the corresponding private key allows an SSH
+"""SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate."""returnSSHHostCertificatesClient(self)@propertydefssh_user_certificates(self)->SSHUserCertificatesClient:
- """SSH User Certificates are presented by SSH clients when connecting to an SSH
+"""SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate."""returnSSHUserCertificatesClient(self)@propertydeftls_certificates(self)->TLSCertificatesClient:
- """TLS Certificates are pairs of x509 certificates and their matching private
+"""TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled
@@ -319,14 +329,14 @@
@propertydeftunnel_sessions(self)->TunnelSessionsClient:
- """Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels."""returnTunnelSessionsClient(self)@propertydeftunnels(self)->TunnelsClient:
- """Tunnels provide endpoints to access services exposed by a running ngrok
+"""Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session."""returnTunnelsClient(self)
diff --git a/docs/_modules/ngrok/datatypes.html b/docs/_modules/ngrok/datatypes.html
index bd641c7..54bcec6 100644
--- a/docs/_modules/ngrok/datatypes.html
+++ b/docs/_modules/ngrok/datatypes.html
@@ -118,6 +118,8 @@
from__future__importannotationsfromtypingimportAny,Mapping,Sequence
+fromdatetimeimportdatetime,timedeltafrom.iteratorimportPagedIterator
@@ -199,12 +202,12 @@
@propertydefid(self)->str:
- """a resource identifier"""
+"""a resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """a uri for locating a resource"""
+"""a uri for locating a resource"""returnself._props["uri"]
@@ -229,37 +232,37 @@
@propertydefid(self)->str:
- """ID of the abuse report"""
+"""ID of the abuse report"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the abuse report API resource"""
+"""URI of the abuse report API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp that the abuse report record was created in RFC 3339 format"""
+"""timestamp that the abuse report record was created in RFC 3339 format"""returnself._props["created_at"]@propertydefurls(self)->Sequence[str]:
- """a list of URLs containing suspected abusive content"""
+"""a list of URLs containing suspected abusive content"""returnself._props["urls"]@propertydefmetadata(self)->str:
- """arbitrary user-defined data about this abuse report. Optional, max 4096 bytes."""
+"""arbitrary user-defined data about this abuse report. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefstatus(self)->str:
- """Indicates whether ngrok has processed the abuse report. one of ``PENDING``, ``PROCESSED``, or ``PARTIALLY_PROCESSED``"""
+"""Indicates whether ngrok has processed the abuse report. one of ``PENDING``, ``PROCESSED``, or ``PARTIALLY_PROCESSED``"""returnself._props["status"]@propertydefhostnames(self)->Sequence[AbuseReportHostname]:
- """an array of hostname statuses related to the report"""
+"""an array of hostname statuses related to the report"""returnself._props["hostnames"]
@@ -279,12 +282,12 @@
@propertydefhostname(self)->str:
- """the hostname ngrok has parsed out of one of the reported URLs in this abuse report"""
+"""the hostname ngrok has parsed out of one of the reported URLs in this abuse report"""returnself._props["hostname"]@propertydefstatus(self)->str:
- """indicates what action ngrok has taken against the hostname. one of ``PENDING``, ``BANNED``, ``UNBANNED``, or ``IGNORE``"""
+"""indicates what action ngrok has taken against the hostname. one of ``PENDING``, ``BANNED``, ``UNBANNED``, or ``IGNORE``"""returnself._props["status"]
@@ -322,42 +325,42 @@
@propertydefid(self)->str:
- """unique Agent Ingress resource identifier"""
+"""unique Agent Ingress resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """URI to the API resource of this Agent ingress"""
+"""URI to the API resource of this Agent ingress"""returnself._props["uri"]@propertydefdescription(self)->str:
- """human-readable description of the use of this Agent Ingress. optional, max 255 bytes."""
+"""human-readable description of the use of this Agent Ingress. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes"""
+"""arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes"""returnself._props["metadata"]@propertydefdomain(self)->str:
- """the domain that you own to be used as the base domain name to generate regional agent ingress domains."""
+"""the domain that you own to be used as the base domain name to generate regional agent ingress domains."""returnself._props["domain"]@propertydefns_targets(self)->Sequence[str]:
- """a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok"""
+"""a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok"""returnself._props["ns_targets"]@propertydefregion_domains(self)->Sequence[str]:
- """a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions"""
+"""a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions"""returnself._props["region_domains"]@propertydefcreated_at(self)->str:
- """timestamp when the Agent Ingress was created, RFC 3339 format"""
+"""timestamp when the Agent Ingress was created, RFC 3339 format"""returnself._props["created_at"]
@@ -385,17 +388,17 @@
@propertydefingresses(self)->Sequence[AgentIngress]:
- """the list of Agent Ingresses owned by this account"""
+"""the list of Agent Ingresses owned by this account"""returnself._props["ingresses"]@propertydefuri(self)->str:
- """URI of the Agent Ingress list API resource"""
+"""URI of the Agent Ingress list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -433,33 +436,38 @@
@propertydefid(self)->str:
- """unique API key resource identifier"""
+"""unique API key resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """URI to the API resource of this API key"""
+"""URI to the API resource of this API key"""returnself._props["uri"]@propertydefdescription(self)->str:
- """human-readable description of what uses the API key to authenticate. optional, max 255 bytes."""
+"""human-readable description of what uses the API key to authenticate. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined data of this API key. optional, max 4096 bytes"""
+"""arbitrary user-defined data of this API key. optional, max 4096 bytes"""returnself._props["metadata"]@propertydefcreated_at(self)->str:
- """timestamp when the api key was created, RFC 3339 format"""
+"""timestamp when the api key was created, RFC 3339 format"""returnself._props["created_at"]@propertydeftoken(self)->str:
- """the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. **This value is only available one time, on the API response from key creation. Otherwise it is null.**"""
- returnself._props["token"]
+"""the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. **This value is only available one time, on the API response from key creation. Otherwise it is null.**"""
+ returnself._props["token"]
+
+ @property
+ defowner_id(self)->str:
+"""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."""
+ returnself._props["owner_id"]
[docs]classAPIKeyList(object):
@@ -486,20 +494,416 @@
@propertydefkeys(self)->Sequence[APIKey]:
- """the list of API keys for this account"""
+"""the list of API keys for this account"""returnself._props["keys"]@propertydefuri(self)->str:
- """URI of the API keys list API resource"""
+"""URI of the API keys list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
+
+ @property
+ defid(self)->str:
+"""unique application session resource identifier"""
+ returnself._props["id"]
+
+ @property
+ defuri(self)->str:
+"""URI of the application session API resource"""
+ returnself._props["uri"]
+
+ @property
+ defpublic_url(self)->str:
+"""URL of the hostport served by this endpoint"""
+ returnself._props["public_url"]
+
+ @property
+ defbrowser_session(self)->BrowserSession:
+"""browser session details of the application session"""
+ returnself._props["browser_session"]
+
+ @property
+ defapplication_user(self)->Ref:
+"""application user this session is associated with"""
+ returnself._props["application_user"]
+
+ @property
+ defcreated_at(self)->str:
+"""timestamp when the user was created in RFC 3339 format"""
+ returnself._props["created_at"]
+
+ @property
+ deflast_active(self)->str:
+"""timestamp when the user was last active in RFC 3339 format"""
+ returnself._props["last_active"]
+
+ @property
+ defexpires_at(self)->str:
+"""timestamp when session expires in RFC 3339 format"""
+ returnself._props["expires_at"]
+
+ @property
+ defendpoint(self)->Ref:
+"""ephemeral endpoint this session is associated with"""
+ returnself._props["endpoint"]
+
+ @property
+ defedge(self)->Ref:
+"""edge this session is associated with, null if the endpoint is agent-initiated"""
+ returnself._props["edge"]
+
+ @property
+ defroute(self)->Ref:
+"""route this session is associated with, null if the endpoint is agent-initiated"""
+ returnself._props["route"]
+
+
+
[docs]classApplicationSessionList(object):
+ def__init__(self,client,props):
+ self._client=client
+ self._props=props
+ self._props["application_sessions"]=(
+ [ApplicationSession(client,x)forxinprops["application_sessions"]]
+ ifprops.get("application_sessions")isnotNone
+ else[]
+ )
+
+ def__eq__(self,other):
+ returnself._props==other._props
+
+ def__str__(self):
+ if"id"inself._props:
+ return"<ApplicationSessionList {}{}>".format(self.id,repr(self._props))
+ else:
+ return"<ApplicationSessionList {}>".format(repr(self._props))
+
+ def__iter__(self):
+ returnPagedIterator(self._client,self,"application_sessions")
+
+ @property
+ defapplication_sessions(self)->Sequence[ApplicationSession]:
+"""list of all application sessions on this account"""
+ returnself._props["application_sessions"]
+
+ @property
+ defuri(self)->str:
+"""URI of the application session list API resource"""
+ returnself._props["uri"]
+
+ @property
+ defnext_page_uri(self)->str:
+"""URI of the next page, or null if there is no next page"""
+ returnself._props["next_page_uri"]
+
+ @property
+ defid(self)->str:
+"""unique application user resource identifier"""
+ returnself._props["id"]
+
+ @property
+ defuri(self)->str:
+"""URI of the application user API resource"""
+ returnself._props["uri"]
+
+ @property
+ defidentity_provider(self)->IdentityProvider:
+"""identity provider that the user authenticated with"""
+ returnself._props["identity_provider"]
+
+ @property
+ defprovider_user_id(self)->str:
+"""unique user identifier"""
+ returnself._props["provider_user_id"]
+
+ @property
+ defusername(self)->str:
+"""user username"""
+ returnself._props["username"]
+
+ @property
+ defemail(self)->str:
+"""user email"""
+ returnself._props["email"]
+
+ @property
+ defname(self)->str:
+"""user common name"""
+ returnself._props["name"]
+
+ @property
+ defcreated_at(self)->str:
+"""timestamp when the user was created in RFC 3339 format"""
+ returnself._props["created_at"]
+
+ @property
+ deflast_active(self)->str:
+"""timestamp when the user was last active in RFC 3339 format"""
+ returnself._props["last_active"]
+
+ @property
+ deflast_login(self)->str:
+"""timestamp when the user last signed-in in RFC 3339 format"""
+ returnself._props["last_login"]
+
+
+
[docs]classApplicationUserList(object):
+ def__init__(self,client,props):
+ self._client=client
+ self._props=props
+ self._props["application_users"]=(
+ [ApplicationUser(client,x)forxinprops["application_users"]]
+ ifprops.get("application_users")isnotNone
+ else[]
+ )
+
+ def__eq__(self,other):
+ returnself._props==other._props
+
+ def__str__(self):
+ if"id"inself._props:
+ return"<ApplicationUserList {}{}>".format(self.id,repr(self._props))
+ else:
+ return"<ApplicationUserList {}>".format(repr(self._props))
+
+ def__iter__(self):
+ returnPagedIterator(self._client,self,"application_users")
+
+ @property
+ defapplication_users(self)->Sequence[ApplicationUser]:
+"""list of all application users on this account"""
+ returnself._props["application_users"]
+
+ @property
+ defuri(self)->str:
+"""URI of the application user list API resource"""
+ returnself._props["uri"]
+
+ @property
+ defnext_page_uri(self)->str:
+"""URI of the next page, or null if there is no next page"""
+ returnself._props["next_page_uri"]
[docs]classFailoverBackend(object):def__init__(self,client,props):self._client=client
@@ -536,32 +940,32 @@
@propertydefid(self)->str:
- """unique identifier for this Failover backend"""
+"""unique identifier for this Failover backend"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the FailoverBackend API resource"""
+"""URI of the FailoverBackend API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the backend was created, RFC 3339 format"""
+"""timestamp when the backend was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this backend. Optional"""
+"""human-readable description of this backend. Optional"""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this backend. Optional"""
+"""arbitrary user-defined machine-readable data of this backend. Optional"""returnself._props["metadata"]@propertydefbackends(self)->Sequence[str]:
- """the ids of the child backends in order"""
+"""the ids of the child backends in order"""returnself._props["backends"]
@@ -589,17 +993,17 @@
@propertydefbackends(self)->Sequence[FailoverBackend]:
- """the list of all Failover backends on this account"""
+"""the list of all Failover backends on this account"""returnself._props["backends"]@propertydefuri(self)->str:
- """URI of the Failover backends list API resource"""
+"""URI of the Failover backends list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -647,37 +1051,37 @@
@propertydefuri(self)->str:
- """URI of the HTTPResponseBackend API resource"""
+"""URI of the HTTPResponseBackend API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the backend was created, RFC 3339 format"""
+"""timestamp when the backend was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this backend. Optional"""
+"""human-readable description of this backend. Optional"""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this backend. Optional"""
+"""arbitrary user-defined machine-readable data of this backend. Optional"""returnself._props["metadata"]@propertydefbody(self)->str:
- """body to return as fixed content"""
+"""body to return as fixed content"""returnself._props["body"]@propertydefheaders(self)->Mapping[str,str]:
- """headers to return"""
+"""headers to return"""returnself._props["headers"]@propertydefstatus_code(self)->int:
- """status code to return"""
+"""status code to return"""returnself._props["status_code"]
@@ -757,37 +1161,37 @@
@propertydefid(self)->str:
- """unique identifier for this TunnelGroup backend"""
+"""unique identifier for this TunnelGroup backend"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the TunnelGroupBackend API resource"""
+"""URI of the TunnelGroupBackend API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the backend was created, RFC 3339 format"""
+"""timestamp when the backend was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this backend. Optional"""
+"""human-readable description of this backend. Optional"""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this backend. Optional"""
+"""arbitrary user-defined machine-readable data of this backend. Optional"""returnself._props["metadata"]@propertydeflabels(self)->Mapping[str,str]:
- """labels to watch for tunnels on, e.g. app->foo, dc->bar"""
+"""labels to watch for tunnels on, e.g. app->foo, dc->bar"""returnself._props["labels"]@propertydeftunnels(self)->Sequence[Ref]:
- """tunnels matching this backend"""
+"""tunnels matching this backend"""returnself._props["tunnels"]
@@ -815,17 +1219,17 @@
@propertydefbackends(self)->Sequence[TunnelGroupBackend]:
- """the list of all TunnelGroup backends on this account"""
+"""the list of all TunnelGroup backends on this account"""returnself._props["backends"]@propertydefuri(self)->str:
- """URI of the TunnelGroup backends list API resource"""
+"""URI of the TunnelGroup backends list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -865,32 +1269,32 @@
@propertydefid(self)->str:
- """unique identifier for this Weighted backend"""
+"""unique identifier for this Weighted backend"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the WeightedBackend API resource"""
+"""URI of the WeightedBackend API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the backend was created, RFC 3339 format"""
+"""timestamp when the backend was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this backend. Optional"""
+"""human-readable description of this backend. Optional"""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this backend. Optional"""
+"""arbitrary user-defined machine-readable data of this backend. Optional"""returnself._props["metadata"]@propertydefbackends(self)->Mapping[str,int]:
- """the ids of the child backends to their weights [0-10000]"""
+"""the ids of the child backends to their weights [0-10000]"""returnself._props["backends"]
@@ -918,17 +1322,17 @@
@propertydefbackends(self)->Sequence[WeightedBackend]:
- """the list of all Weighted backends on this account"""
+"""the list of all Weighted backends on this account"""returnself._props["backends"]@propertydefuri(self)->str:
- """URI of the Weighted backends list API resource"""
+"""URI of the Weighted backends list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -966,57 +1370,57 @@
@propertydefid(self)->str:
- """unique identifier for this Certificate Authority"""
+"""unique identifier for this Certificate Authority"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the Certificate Authority API resource"""
+"""URI of the Certificate Authority API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the Certificate Authority was created, RFC 3339 format"""
+"""timestamp when the Certificate Authority was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this Certificate Authority. optional, max 255 bytes."""
+"""human-readable description of this Certificate Authority. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefca_pem(self)->str:
- """raw PEM of the Certificate Authority"""
+"""raw PEM of the Certificate Authority"""returnself._props["ca_pem"]@propertydefsubject_common_name(self)->str:
- """subject common name of the Certificate Authority"""
+"""subject common name of the Certificate Authority"""returnself._props["subject_common_name"]@propertydefnot_before(self)->str:
- """timestamp when this Certificate Authority becomes valid, RFC 3339 format"""
+"""timestamp when this Certificate Authority becomes valid, RFC 3339 format"""returnself._props["not_before"]@propertydefnot_after(self)->str:
- """timestamp when this Certificate Authority becomes invalid, RFC 3339 format"""
+"""timestamp when this Certificate Authority becomes invalid, RFC 3339 format"""returnself._props["not_after"]@propertydefkey_usages(self)->Sequence[str]:
- """set of actions the private key of this Certificate Authority can be used for"""
+"""set of actions the private key of this Certificate Authority can be used for"""returnself._props["key_usages"]@propertydefextended_key_usages(self)->Sequence[str]:
- """extended set of actions the private key of this Certificate Authority can be used for"""
+"""extended set of actions the private key of this Certificate Authority can be used for"""returnself._props["extended_key_usages"]
@@ -1044,17 +1448,17 @@
@propertydefcertificate_authorities(self)->Sequence[CertificateAuthority]:
- """the list of all certificate authorities on this account"""
+"""the list of all certificate authorities on this account"""returnself._props["certificate_authorities"]@propertydefuri(self)->str:
- """URI of the certificates authorities list API resource"""
+"""URI of the certificates authorities list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -1094,38 +1498,43 @@
@propertydefid(self)->str:
- """unique tunnel credential resource identifier"""
+"""unique tunnel credential resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the tunnel credential API resource"""
+"""URI of the tunnel credential API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the tunnel credential was created, RFC 3339 format"""
+"""timestamp when the tunnel credential was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes."""
+"""human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydeftoken(self)->str:
- """the credential's authtoken that can be used to authenticate an ngrok agent. **This value is only available one time, on the API response from credential creation, otherwise it is null.**"""
+"""the credential's authtoken that can be used to authenticate an ngrok agent. **This value is only available one time, on the API response from credential creation, otherwise it is null.**"""returnself._props["token"]@propertydefacl(self)->Sequence[str]:
- """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 and addresses 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 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. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions."""
- returnself._props["acl"]
+"""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."""
+ returnself._props["acl"]
+
+ @property
+ defowner_id(self)->str:
+"""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."""
+ returnself._props["owner_id"]
[docs]classCredentialList(object):
@@ -1152,17 +1561,17 @@
@propertydefcredentials(self)->Sequence[Credential]:
- """the list of all tunnel credentials on this account"""
+"""the list of all tunnel credentials on this account"""returnself._props["credentials"]@propertydefuri(self)->str:
- """URI of the tunnel credential list API resource"""
+"""URI of the tunnel credential list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -1184,17 +1593,17 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefprovider(self)->str:
- """a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: ``SLACK``, ``SNS``, ``STRIPE``, ``GITHUB``, ``TWILIO``, ``SHOPIFY``, ``GITLAB``, ``INTERCOM``, ``SENDGRID``, ``XERO``, ``PAGERDUTY``."""
+"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at `https://ngrok.com/docs/cloud-edge/modules/webhook <https://ngrok.com/docs/cloud-edge/modules/webhook>`_"""returnself._props["provider"]@propertydefsecret(self)->str:
- """a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret"""
+"""a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret"""returnself._props["secret"]
@@ -1214,7 +1623,7 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]
@@ -1239,12 +1648,12 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefcertificate_authorities(self)->Sequence[Ref]:
- """PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together."""
+"""PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together."""returnself._props["certificate_authorities"]
@@ -1264,12 +1673,12 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefcertificate_authority_ids(self)->Sequence[str]:
- """list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection"""
+"""list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection"""returnself._props["certificate_authority_ids"]
@@ -1289,17 +1698,17 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefterminate_at(self)->str:
- """``edge`` if the ngrok edge should terminate TLS traffic, ``upstream`` if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if ``upstream`` is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic."""
+"""``edge`` if the ngrok edge should terminate TLS traffic, ``upstream`` if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if ``upstream`` is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic."""returnself._props["terminate_at"]@propertydefmin_version(self)->str:
- """The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if ``terminate_at`` is set to ``upstream``."""
+"""The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if ``terminate_at`` is set to ``upstream``."""returnself._props["min_version"]
@@ -1321,12 +1730,12 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefmin_version(self)->str:
- """The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if ``terminate_at`` is set to ``upstream``."""
+"""The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if ``terminate_at`` is set to ``upstream``."""returnself._props["min_version"]
@@ -1346,17 +1755,17 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefadd(self)->Mapping[str,str]:
- """a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server"""
+"""a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server"""returnself._props["add"]@propertydefremove(self)->Sequence[str]:
- """a list of header names that will be removed from the HTTP Request before being sent to the upstream application server"""
+"""a list of header names that will be removed from the HTTP Request before being sent to the upstream application server"""returnself._props["remove"]
@@ -1376,17 +1785,17 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefadd(self)->Mapping[str,str]:
- """a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client"""
+"""a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client"""returnself._props["add"]@propertydefremove(self)->Sequence[str]:
- """a list of header names that will be removed from the HTTP Response returned to the HTTP client"""
+"""a list of header names that will be removed from the HTTP Response returned to the HTTP client"""returnself._props["remove"]
@@ -1411,7 +1820,7 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@property
@@ -1435,12 +1844,12 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefip_policy_ids(self)->Sequence[str]:
- """list of all IP policies that will be used to check if a source IP is allowed access to the endpoint"""
+"""list of all IP policies that will be used to check if a source IP is allowed access to the endpoint"""returnself._props["ip_policy_ids"]
@@ -1460,32 +1869,32 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@property
- deftripped_duration(self)->int:
- """Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health"""
- returnself._props["tripped_duration"]
+ deftripped_duration(self)->timedelta:
+"""Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health"""
+ returntimedelta(seconds=self._props["tripped_duration"])@propertydefrolling_window(self)->int:
- """Integer number of seconds in the statistical rolling window that metrics are retained for."""
+"""Integer number of seconds in the statistical rolling window that metrics are retained for."""returnself._props["rolling_window"]@propertydefnum_buckets(self)->int:
- """Integer number of buckets into which metrics are retained. Max 128."""
+"""Integer number of buckets into which metrics are retained. Max 128."""returnself._props["num_buckets"]@propertydefvolume_threshold(self)->int:
- """Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low."""
+"""Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low."""returnself._props["volume_threshold"]@propertydeferror_threshold_percentage(self)->float:
- """Error threshold percentage should be between 0 - 1.0, not 0-100.0"""
+"""Error threshold percentage should be between 0 - 1.0, not 0-100.0"""returnself._props["error_threshold_percentage"]
@@ -1510,37 +1919,37 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefprovider(self)->EndpointOAuthProvider:
- """an object which defines the identity provider to use for authentication and configuration for who may access the endpoint"""
+"""an object which defines the identity provider to use for authentication and configuration for who may access the endpoint"""returnself._props["provider"]@propertydefoptions_passthrough(self)->bool:
- """Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""
+"""Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""returnself._props["options_passthrough"]@propertydefcookie_prefix(self)->str:
- """the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""
+"""the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""returnself._props["cookie_prefix"]@propertydefinactivity_timeout(self)->int:
- """Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""
+"""Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""returnself._props["inactivity_timeout"]@property
- defmaximum_duration(self)->int:
- """Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
- returnself._props["maximum_duration"]
+ defmaximum_duration(self)->timedelta:
+"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
+ returntimedelta(seconds=self._props["maximum_duration"])@propertydefauth_check_interval(self)->int:
- """Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource."""
+"""Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource."""returnself._props["auth_check_interval"]
@@ -1568,6 +1977,26 @@
ifprops.get("google")isnotNoneelseNone)
+ self._props["linkedin"]=(
+ EndpointOAuthLinkedIn(client,props["linkedin"])
+ ifprops.get("linkedin")isnotNone
+ elseNone
+ )
+ self._props["gitlab"]=(
+ EndpointOAuthGitLab(client,props["gitlab"])
+ ifprops.get("gitlab")isnotNone
+ elseNone
+ )
+ self._props["twitch"]=(
+ EndpointOAuthTwitch(client,props["twitch"])
+ ifprops.get("twitch")isnotNone
+ elseNone
+ )
+ self._props["amazon"]=(
+ EndpointOAuthAmazon(client,props["amazon"])
+ ifprops.get("amazon")isnotNone
+ elseNone
+ )def__eq__(self,other):returnself._props==other._props
@@ -1580,23 +2009,43 @@
@propertydefgithub(self)->EndpointOAuthGitHub:
- """configuration for using github as the identity provider"""
+"""configuration for using github as the identity provider"""returnself._props["github"]@propertydeffacebook(self)->EndpointOAuthFacebook:
- """configuration for using facebook as the identity provider"""
+"""configuration for using facebook as the identity provider"""returnself._props["facebook"]@propertydefmicrosoft(self)->EndpointOAuthMicrosoft:
- """configuration for using microsoft as the identity provider"""
+"""configuration for using microsoft as the identity provider"""returnself._props["microsoft"]@propertydefgoogle(self)->EndpointOAuthGoogle:
- """configuration for using google as the identity provider"""
- returnself._props["google"]
+"""configuration for using google as the identity provider"""
+ returnself._props["google"]
+
+ @property
+ deflinkedin(self)->EndpointOAuthLinkedIn:
+"""configuration for using linkedin as the identity provider"""
+ returnself._props["linkedin"]
+
+ @property
+ defgitlab(self)->EndpointOAuthGitLab:
+"""configuration for using gitlab as the identity provider"""
+ returnself._props["gitlab"]
+
+ @property
+ deftwitch(self)->EndpointOAuthTwitch:
+"""configuration for using twitch as the identity provider"""
+ returnself._props["twitch"]
+
+ @property
+ defamazon(self)->EndpointOAuthAmazon:
+"""configuration for using amazon as the identity provider"""
+ returnself._props["amazon"]
[docs]classEndpointOAuthGitHub(object):
@@ -1615,37 +2064,37 @@
@propertydefclient_id(self)->str:
- """the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""
+"""the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""returnself._props["client_id"]@propertydefclient_secret(self)->str:
- """the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""
+"""the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""returnself._props["client_secret"]@propertydefscopes(self)->Sequence[str]:
- """a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""
+"""a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""returnself._props["scopes"]@propertydefemail_addresses(self)->Sequence[str]:
- """a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""
+"""a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_addresses"]@propertydefemail_domains(self)->Sequence[str]:
- """a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""
+"""a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_domains"]@propertydefteams(self)->Sequence[str]:
- """a list of github teams identifiers. users will be allowed access to the endpoint if they are a member of any of these teams. identifiers should be in the 'slug' format qualified with the org name, e.g. ``org-name/team-name``"""
+"""a list of github teams identifiers. users will be allowed access to the endpoint if they are a member of any of these teams. identifiers should be in the 'slug' format qualified with the org name, e.g. ``org-name/team-name``"""returnself._props["teams"]@propertydeforganizations(self)->Sequence[str]:
- """a list of github org identifiers. users who are members of any of the listed organizations will be allowed access. identifiers should be the organization's 'slug'"""
+"""a list of github org identifiers. users who are members of any of the listed organizations will be allowed access. identifiers should be the organization's 'slug'"""returnself._props["organizations"]
@@ -1665,27 +2114,27 @@
@propertydefclient_id(self)->str:
- """the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""
+"""the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""returnself._props["client_id"]@propertydefclient_secret(self)->str:
- """the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""
+"""the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""returnself._props["client_secret"]@propertydefscopes(self)->Sequence[str]:
- """a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""
+"""a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""returnself._props["scopes"]@propertydefemail_addresses(self)->Sequence[str]:
- """a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""
+"""a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_addresses"]@propertydefemail_domains(self)->Sequence[str]:
- """a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""
+"""a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_domains"]
@@ -1705,27 +2154,27 @@
@propertydefclient_id(self)->str:
- """the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""
+"""the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""returnself._props["client_id"]@propertydefclient_secret(self)->str:
- """the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""
+"""the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""returnself._props["client_secret"]@propertydefscopes(self)->Sequence[str]:
- """a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""
+"""a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""returnself._props["scopes"]@propertydefemail_addresses(self)->Sequence[str]:
- """a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""
+"""a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_addresses"]@propertydefemail_domains(self)->Sequence[str]:
- """a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""
+"""a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_domains"]
@@ -1745,27 +2194,167 @@
@propertydefclient_id(self)->str:
- """the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""
+"""the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well."""
+ returnself._props["client_id"]
+
+ @property
+ defclient_secret(self)->str:
+"""the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""
+ returnself._props["client_secret"]
+
+ @property
+ defscopes(self)->Sequence[str]:
+"""a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""
+ returnself._props["scopes"]
+
+ @property
+ defemail_addresses(self)->Sequence[str]:
+"""a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""
+ returnself._props["email_addresses"]
+
+ @property
+ defemail_domains(self)->Sequence[str]:
+"""a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""
+ returnself._props["email_domains"]
+
+
+
[docs]classEndpointOAuthAmazon(object):
+ def__init__(self,client,props):
+ self._client=client
+ self._props=props
+
+ def__eq__(self,other):
+ returnself._props==other._props
+
+ def__str__(self):
+ if"id"inself._props:
+ return"<EndpointOAuthAmazon {}{}>".format(self.id,repr(self._props))
+ else:
+ return"<EndpointOAuthAmazon {}>".format(repr(self._props))
+
+ @property
+ defclient_id(self)->str:returnself._props["client_id"]@propertydefclient_secret(self)->str:
- """the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for ``client_id``."""returnself._props["client_secret"]@propertydefscopes(self)->Sequence[str]:
- """a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both ``client_id`` and ``client_secret`` to set scopes)"""returnself._props["scopes"]@propertydefemail_addresses(self)->Sequence[str]:
- """a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_addresses"]@propertydefemail_domains(self)->Sequence[str]:
- """a list of email domains of users authenticated by identity provider who are allowed access to the endpoint"""returnself._props["email_domains"]
@@ -1785,77 +2374,77 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefoptions_passthrough(self)->bool:
- """Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""
+"""Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""returnself._props["options_passthrough"]@propertydefcookie_prefix(self)->str:
- """the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""
+"""the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""returnself._props["cookie_prefix"]@propertydefinactivity_timeout(self)->int:
- """Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""
+"""Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""returnself._props["inactivity_timeout"]@property
- defmaximum_duration(self)->int:
- """Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
- returnself._props["maximum_duration"]
+ defmaximum_duration(self)->timedelta:
+"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
+ returntimedelta(seconds=self._props["maximum_duration"])@propertydefidp_metadata(self)->str:
- """The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL."""
+"""The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL."""returnself._props["idp_metadata"]@propertydefforce_authn(self)->bool:
- """If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP."""
+"""If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP."""returnself._props["force_authn"]@propertydefallow_idp_initiated(self)->bool:
- """If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the ``RelayState`` parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed."""
+"""If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the ``RelayState`` parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed."""returnself._props["allow_idp_initiated"]@propertydefauthorized_groups(self)->Sequence[str]:
- """If present, only users who are a member of one of the listed groups may access the target endpoint."""
+"""If present, only users who are a member of one of the listed groups may access the target endpoint."""returnself._props["authorized_groups"]@propertydefentity_id(self)->str:
- """The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration."""
+"""The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration."""returnself._props["entity_id"]@propertydefassertion_consumer_service_url(self)->str:
- """The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration."""
+"""The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration."""returnself._props["assertion_consumer_service_url"]@propertydefsingle_logout_url(self)->str:
- """The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration."""
+"""The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration."""returnself._props["single_logout_url"]@propertydefrequest_signing_certificate_pem(self)->str:
- """PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported."""
+"""PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported."""returnself._props["request_signing_certificate_pem"]@propertydefmetadata_url(self)->str:
- """A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata."""
+"""A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata."""returnself._props["metadata_url"]@propertydefnameid_format(self)->str:
- """Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of ``urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`` will be used. A subset of the allowed values enumerated by the SAML specification are supported."""
+"""Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of ``urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`` will be used. A subset of the allowed values enumerated by the SAML specification are supported."""returnself._props["nameid_format"]
@@ -1875,52 +2464,52 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefoptions_passthrough(self)->bool:
- """Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""
+"""Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""returnself._props["options_passthrough"]@propertydefcookie_prefix(self)->str:
- """the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""
+"""the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""returnself._props["cookie_prefix"]@propertydefinactivity_timeout(self)->int:
- """Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""
+"""Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""returnself._props["inactivity_timeout"]@property
- defmaximum_duration(self)->int:
- """Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
- returnself._props["maximum_duration"]
+ defmaximum_duration(self)->timedelta:
+"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
+ returntimedelta(seconds=self._props["maximum_duration"])@propertydefidp_metadata(self)->str:
- """The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL."""
+"""The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL."""returnself._props["idp_metadata"]@propertydefforce_authn(self)->bool:
- """If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP."""
+"""If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP."""returnself._props["force_authn"]@propertydefallow_idp_initiated(self)->bool:
- """If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the ``RelayState`` parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed."""
+"""If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the ``RelayState`` parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed."""returnself._props["allow_idp_initiated"]@propertydefauthorized_groups(self)->Sequence[str]:
- """If present, only users who are a member of one of the listed groups may access the target endpoint."""
+"""If present, only users who are a member of one of the listed groups may access the target endpoint."""returnself._props["authorized_groups"]@propertydefnameid_format(self)->str:
- """Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of ``urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`` will be used. A subset of the allowed values enumerated by the SAML specification are supported."""
+"""Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of ``urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`` will be used. A subset of the allowed values enumerated by the SAML specification are supported."""returnself._props["nameid_format"]
@@ -1940,47 +2529,47 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefoptions_passthrough(self)->bool:
- """Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""
+"""Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS."""returnself._props["options_passthrough"]@propertydefcookie_prefix(self)->str:
- """the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""
+"""the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'"""returnself._props["cookie_prefix"]@propertydefinactivity_timeout(self)->int:
- """Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""
+"""Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate."""returnself._props["inactivity_timeout"]@property
- defmaximum_duration(self)->int:
- """Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
- returnself._props["maximum_duration"]
+ defmaximum_duration(self)->timedelta:
+"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
+ returntimedelta(seconds=self._props["maximum_duration"])@propertydefissuer(self)->str:
- """URL of the OIDC "OpenID provider". This is the base URL used for discovery."""
+"""URL of the OIDC "OpenID provider". This is the base URL used for discovery."""returnself._props["issuer"]@propertydefclient_id(self)->str:
- """The OIDC app's client ID and OIDC audience."""
+"""The OIDC app's client ID and OIDC audience."""returnself._props["client_id"]@propertydefclient_secret(self)->str:
- """The OIDC app's client secret."""
+"""The OIDC app's client secret."""returnself._props["client_secret"]@propertydefscopes(self)->Sequence[str]:
- """The set of scopes to request from the OIDC identity provider."""
+"""The set of scopes to request from the OIDC identity provider."""returnself._props["scopes"]
@@ -2003,12 +2592,12 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefbackend(self)->Ref:
- """backend to be used to back this endpoint"""
+"""backend to be used to back this endpoint"""returnself._props["backend"]
@@ -2028,12 +2617,12 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]@propertydefbackend_id(self)->str:
- """backend to be used to back this endpoint"""
+"""backend to be used to back this endpoint"""returnself._props["backend_id"]
@@ -2055,7 +2644,7 @@
@propertydefenabled(self)->bool:
- """``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""
+"""``true`` if the module will be applied to traffic, ``false`` to disable. default ``true`` if unspecified"""returnself._props["enabled"]
@@ -2176,97 +2765,97 @@
@propertydefedge_id(self)->str:
- """unique identifier of this edge"""
+"""unique identifier of this edge"""returnself._props["edge_id"]@propertydefid(self)->str:
- """unique identifier of this edge route"""
+"""unique identifier of this edge route"""returnself._props["id"]@propertydefcreated_at(self)->str:
- """timestamp when the edge configuration was created, RFC 3339 format"""
+"""timestamp when the edge configuration was created, RFC 3339 format"""returnself._props["created_at"]@propertydefmatch_type(self)->str:
- """Type of match to use for this route. Valid values are "exact_path" and "path_prefix"."""
+"""Type of match to use for this route. Valid values are "exact_path" and "path_prefix"."""returnself._props["match_type"]@propertydefmatch(self)->str:
- """Route selector: "/blog" or "example.com" or "example.com/blog" """
+"""Route selector: "/blog" or "example.com" or "example.com/blog" """returnself._props["match"]@propertydefuri(self)->str:
- """URI of the edge API resource"""
+"""URI of the edge API resource"""returnself._props["uri"]@propertydefdescription(self)->str:
- """human-readable description of what this edge will be used for; optional, max 255 bytes."""
+"""human-readable description of what this edge will be used for; optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefbackend(self)->EndpointBackend:
- """backend module configuration or ``null``"""
+"""backend module configuration or ``null``"""returnself._props["backend"]@propertydefip_restriction(self)->EndpointIPPolicy:
- """ip restriction module configuration or ``null``"""
+"""ip restriction module configuration or ``null``"""returnself._props["ip_restriction"]@propertydefcircuit_breaker(self)->EndpointCircuitBreaker:
- """circuit breaker module configuration or ``null``"""
+"""circuit breaker module configuration or ``null``"""returnself._props["circuit_breaker"]@propertydefcompression(self)->EndpointCompression:
- """compression module configuration or ``null``"""
+"""compression module configuration or ``null``"""returnself._props["compression"]@propertydefrequest_headers(self)->EndpointRequestHeaders:
- """request headers module configuration or ``null``"""
+"""request headers module configuration or ``null``"""returnself._props["request_headers"]@propertydefresponse_headers(self)->EndpointResponseHeaders:
- """response headers module configuration or ``null``"""
+"""response headers module configuration or ``null``"""returnself._props["response_headers"]@propertydefwebhook_verification(self)->EndpointWebhookValidation:
- """webhook verification module configuration or ``null``"""
+"""webhook verification module configuration or ``null``"""returnself._props["webhook_verification"]@propertydefoauth(self)->EndpointOAuth:
- """oauth module configuration or ``null``"""
+"""oauth module configuration or ``null``"""returnself._props["oauth"]@propertydefsaml(self)->EndpointSAML:
- """saml module configuration or ``null``"""
+"""saml module configuration or ``null``"""returnself._props["saml"]@propertydefoidc(self)->EndpointOIDC:
- """oidc module configuration or ``null``"""
+"""oidc module configuration or ``null``"""returnself._props["oidc"]@propertydefwebsocket_tcp_converter(self)->EndpointWebsocketTCPConverter:
- """websocket to tcp adapter configuration or ``null``"""
+"""websocket to tcp adapter configuration or ``null``"""returnself._props["websocket_tcp_converter"]
@@ -2294,17 +2883,17 @@
@propertydefhttps_edges(self)->Sequence[HTTPSEdge]:
- """the list of all HTTPS Edges on this account"""
+"""the list of all HTTPS Edges on this account"""returnself._props["https_edges"]@propertydefuri(self)->str:
- """URI of the HTTPS Edge list API resource"""
+"""URI of the HTTPS Edge list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -2363,37 +2952,37 @@
@propertydefid(self)->str:
- """unique identifier of this edge"""
+"""unique identifier of this edge"""returnself._props["id"]@propertydefdescription(self)->str:
- """human-readable description of what this edge will be used for; optional, max 255 bytes."""
+"""human-readable description of what this edge will be used for; optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes."""returnself._props["metadata"]@propertydefcreated_at(self)->str:
- """timestamp when the edge configuration was created, RFC 3339 format"""
+"""timestamp when the edge configuration was created, RFC 3339 format"""returnself._props["created_at"]@propertydefuri(self)->str:
- """URI of the edge API resource"""
+"""URI of the edge API resource"""returnself._props["uri"]@propertydefhostports(self)->Sequence[str]:
- """hostports served by this edge"""
+"""hostports served by this edge"""returnself._props["hostports"]@propertydefmutual_tls(self)->EndpointMutualTLS:
- """edge modules"""
+"""edge modules"""returnself._props["mutual_tls"]@property
@@ -2402,7 +2991,7 @@
@propertydefroutes(self)->Sequence[HTTPSEdgeRoute]:
- """routes"""
+"""routes"""returnself._props["routes"]
@@ -2430,17 +3019,17 @@
@propertydeftcp_edges(self)->Sequence[TCPEdge]:
- """the list of all TCP Edges on this account"""
+"""the list of all TCP Edges on this account"""returnself._props["tcp_edges"]@propertydefuri(self)->str:
- """URI of the TCP Edge list API resource"""
+"""URI of the TCP Edge list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -2494,37 +3083,37 @@
@propertydefid(self)->str:
- """unique identifier of this edge"""
+"""unique identifier of this edge"""returnself._props["id"]@propertydefdescription(self)->str:
- """human-readable description of what this edge will be used for; optional, max 255 bytes."""
+"""human-readable description of what this edge will be used for; optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefcreated_at(self)->str:
- """timestamp when the edge was created, RFC 3339 format"""
+"""timestamp when the edge was created, RFC 3339 format"""returnself._props["created_at"]@propertydefuri(self)->str:
- """URI of the edge API resource"""
+"""URI of the edge API resource"""returnself._props["uri"]@propertydefhostports(self)->Sequence[str]:
- """hostports served by this edge"""
+"""hostports served by this edge"""returnself._props["hostports"]@propertydefbackend(self)->EndpointBackend:
- """edge modules"""
+"""edge modules"""returnself._props["backend"]@property
@@ -2556,17 +3145,17 @@
@propertydeftls_edges(self)->Sequence[TLSEdge]:
- """the list of all TLS Edges on this account"""
+"""the list of all TLS Edges on this account"""returnself._props["tls_edges"]@propertydefuri(self)->str:
- """URI of the TLS Edge list API resource"""
+"""URI of the TLS Edge list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -2634,37 +3223,37 @@
@propertydefid(self)->str:
- """unique identifier of this edge"""
+"""unique identifier of this edge"""returnself._props["id"]@propertydefdescription(self)->str:
- """human-readable description of what this edge will be used for; optional, max 255 bytes."""
+"""human-readable description of what this edge will be used for; optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefcreated_at(self)->str:
- """timestamp when the edge configuration was created, RFC 3339 format"""
+"""timestamp when the edge configuration was created, RFC 3339 format"""returnself._props["created_at"]@propertydefuri(self)->str:
- """URI of the edge API resource"""
+"""URI of the edge API resource"""returnself._props["uri"]@propertydefhostports(self)->Sequence[str]:
- """hostports served by this edge"""
+"""hostports served by this edge"""returnself._props["hostports"]@propertydefbackend(self)->EndpointBackend:
- """edge modules"""
+"""edge modules"""returnself._props["backend"]@property
@@ -2710,67 +3299,67 @@
@propertydefid(self)->str:
- """unique endpoint resource identifier"""
+"""unique endpoint resource identifier"""returnself._props["id"]@propertydefregion(self)->str:
- """identifier of the region this endpoint belongs to"""
+"""identifier of the region this endpoint belongs to"""returnself._props["region"]@propertydefcreated_at(self)->str:
- """timestamp when the endpoint was created in RFC 3339 format"""
+"""timestamp when the endpoint was created in RFC 3339 format"""returnself._props["created_at"]@propertydefupdated_at(self)->str:
- """timestamp when the endpoint was updated in RFC 3339 format"""
+"""timestamp when the endpoint was updated in RFC 3339 format"""returnself._props["updated_at"]@propertydefpublic_url(self)->str:
- """URL of the hostport served by this endpoint"""
+"""URL of the hostport served by this endpoint"""returnself._props["public_url"]@propertydefproto(self)->str:
- """protocol served by this endpoint. one of ``http``, ``https``, ``tcp``, or ``tls``"""
+"""protocol served by this endpoint. one of ``http``, ``https``, ``tcp``, or ``tls``"""returnself._props["proto"]@propertydefhostport(self)->str:
- """hostport served by this endpoint (hostname:port)"""
+"""hostport served by this endpoint (hostname:port)"""returnself._props["hostport"]@propertydeftype(self)->str:
- """whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge)"""
+"""whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge)"""returnself._props["type"]@propertydefmetadata(self)->str:
- """user-supplied metadata of the associated tunnel or edge object"""
+"""user-supplied metadata of the associated tunnel or edge object"""returnself._props["metadata"]@propertydefdomain(self)->Ref:
- """the domain reserved for this endpoint"""
+"""the domain reserved for this endpoint"""returnself._props["domain"]@propertydeftcp_addr(self)->Ref:
- """the address reserved for this endpoint"""
+"""the address reserved for this endpoint"""returnself._props["tcp_addr"]@propertydeftunnel(self)->Ref:
- """the tunnel serving requests to this endpoint, if this is an ephemeral endpoint"""
+"""the tunnel serving requests to this endpoint, if this is an ephemeral endpoint"""returnself._props["tunnel"]@propertydefedge(self)->Ref:
- """the edge serving requests to this endpoint, if this is an edge endpoint"""
+"""the edge serving requests to this endpoint, if this is an edge endpoint"""returnself._props["edge"]
@@ -2798,17 +3387,17 @@
@propertydefendpoints(self)->Sequence[Endpoint]:
- """the list of all active endpoints on this account"""
+"""the list of all active endpoints on this account"""returnself._props["endpoints"]@propertydefuri(self)->str:
- """URI of the endpoints list API resource"""
+"""URI of the endpoints list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -2840,37 +3429,37 @@
@propertydefid(self)->str:
- """Unique identifier for this Event Destination."""
+"""Unique identifier for this Event Destination."""returnself._props["id"]@propertydefmetadata(self)->str:
- """Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes."""
+"""Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefcreated_at(self)->str:
- """Timestamp when the Event Destination was created, RFC 3339 format."""
+"""Timestamp when the Event Destination was created, RFC 3339 format."""returnself._props["created_at"]@propertydefdescription(self)->str:
- """Human-readable description of the Event Destination. Optional, max 255 bytes."""
+"""Human-readable description of the Event Destination. Optional, max 255 bytes."""returnself._props["description"]@propertydefformat(self)->str:
- """The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``."""
+"""The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``."""returnself._props["format"]@propertydeftarget(self)->EventTarget:
- """An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``."""
+"""An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``."""returnself._props["target"]@propertydefuri(self)->str:
- """URI of the Event Destination API resource."""
+"""URI of the Event Destination API resource."""returnself._props["uri"]
@@ -2898,17 +3487,17 @@
@propertydefevent_destinations(self)->Sequence[EventDestination]:
- """The list of all Event Destinations on this account."""
+"""The list of all Event Destinations on this account."""returnself._props["event_destinations"]@propertydefuri(self)->str:
- """URI of the Event Destinations list API resource."""
+"""URI of the Event Destinations list API resource."""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page."""
+"""URI of the next page, or null if there is no next page."""returnself._props["next_page_uri"]
@@ -2943,17 +3532,17 @@
@propertydeffirehose(self)->EventTargetFirehose:
- """Configuration used to send events to Amazon Kinesis Data Firehose."""
+"""Configuration used to send events to Amazon Kinesis Data Firehose."""returnself._props["firehose"]@propertydefkinesis(self)->EventTargetKinesis:
- """Configuration used to send events to Amazon Kinesis."""
+"""Configuration used to send events to Amazon Kinesis."""returnself._props["kinesis"]@propertydefcloudwatch_logs(self)->EventTargetCloudwatchLogs:
- """Configuration used to send events to Amazon CloudWatch Logs."""
+"""Configuration used to send events to Amazon CloudWatch Logs."""returnself._props["cloudwatch_logs"]
@@ -2976,12 +3565,12 @@
@propertydefauth(self)->AWSAuth:
- """Configuration for how to authenticate into your AWS account. Exactly one of ``role`` or ``creds`` should be configured."""
+"""Configuration for how to authenticate into your AWS account. Exactly one of ``role`` or ``creds`` should be configured."""returnself._props["auth"]@propertydefdelivery_stream_arn(self)->str:
- """An Amazon Resource Name specifying the Firehose delivery stream to deposit events into."""
+"""An Amazon Resource Name specifying the Firehose delivery stream to deposit events into."""returnself._props["delivery_stream_arn"]
@@ -3004,12 +3593,12 @@
@propertydefauth(self)->AWSAuth:
- """Configuration for how to authenticate into your AWS account. Exactly one of ``role`` or ``creds`` should be configured."""
+"""Configuration for how to authenticate into your AWS account. Exactly one of ``role`` or ``creds`` should be configured."""returnself._props["auth"]@propertydefstream_arn(self)->str:
- """An Amazon Resource Name specifying the Kinesis stream to deposit events into."""
+"""An Amazon Resource Name specifying the Kinesis stream to deposit events into."""returnself._props["stream_arn"]
@@ -3034,12 +3623,12 @@
@propertydefauth(self)->AWSAuth:
- """Configuration for how to authenticate into your AWS account. Exactly one of ``role`` or ``creds`` should be configured."""
+"""Configuration for how to authenticate into your AWS account. Exactly one of ``role`` or ``creds`` should be configured."""returnself._props["auth"]@propertydeflog_group_arn(self)->str:
- """An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into."""
+"""An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into."""returnself._props["log_group_arn"]
@@ -3067,12 +3656,12 @@
@propertydefrole(self)->AWSRole:
- """A role for ngrok to assume on your behalf to deposit events into your AWS account."""
+"""A role for ngrok to assume on your behalf to deposit events into your AWS account."""returnself._props["role"]@propertydefcreds(self)->AWSCredentials:
- """Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys."""
+"""Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys."""returnself._props["creds"]
@@ -3092,7 +3681,7 @@
@propertydefrole_arn(self)->str:
- """An ARN that specifies the role that ngrok should use to deliver to the configured target."""
+"""An ARN that specifies the role that ngrok should use to deliver to the configured target."""returnself._props["role_arn"]
@@ -3112,12 +3701,12 @@
@propertydefaws_access_key_id(self)->str:
- """The ID portion of an AWS access key."""
+"""The ID portion of an AWS access key."""returnself._props["aws_access_key_id"]@propertydefaws_secret_access_key(self)->str:
- """The secret portion of an AWS access key."""
+"""The secret portion of an AWS access key."""returnself._props["aws_secret_access_key"]
@@ -3145,17 +3734,17 @@
@propertydefevent_subscriptions(self)->Sequence[EventSubscription]:
- """The list of all Event Subscriptions on this account."""
+"""The list of all Event Subscriptions on this account."""returnself._props["event_subscriptions"]@propertydefuri(self)->str:
- """URI of the Event Subscriptions list API resource."""
+"""URI of the Event Subscriptions list API resource."""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of next page, or null if there is no next page."""
+"""URI of next page, or null if there is no next page."""returnself._props["next_page_uri"]
@@ -3192,37 +3781,37 @@
@propertydefid(self)->str:
- """Unique identifier for this Event Subscription."""
+"""Unique identifier for this Event Subscription."""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the Event Subscription API resource."""
+"""URI of the Event Subscription API resource."""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """When the Event Subscription was created (RFC 3339 format)."""
+"""When the Event Subscription was created (RFC 3339 format)."""returnself._props["created_at"]@propertydefmetadata(self)->str:
- """Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars."""
+"""Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars."""returnself._props["metadata"]@propertydefdescription(self)->str:
- """Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars."""
+"""Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars."""returnself._props["description"]@propertydefsources(self)->Sequence[EventSource]:
- """Sources containing the types for which this event subscription will trigger"""
+"""Sources containing the types for which this event subscription will trigger"""returnself._props["sources"]@propertydefdestinations(self)->Sequence[Ref]:
- """Destinations to which these events will be sent"""
+"""Destinations to which these events will be sent"""returnself._props["destinations"]
@@ -3242,7 +3831,7 @@
@propertydeftype(self)->str:
- """Type of event for which an event subscription will trigger"""
+"""Type of event for which an event subscription will trigger"""returnself._props["type"]
@@ -3262,12 +3851,12 @@
@propertydeftype(self)->str:
- """Type of event for which an event subscription will trigger"""
+"""Type of event for which an event subscription will trigger"""returnself._props["type"]@propertydefuri(self)->str:
- """URI of the Event Source API resource."""
+"""URI of the Event Source API resource."""returnself._props["uri"]
@@ -3292,12 +3881,12 @@
@propertydefsources(self)->Sequence[EventSource]:
- """The list of all Event Sources for an Event Subscription"""
+"""The list of all Event Sources for an Event Subscription"""returnself._props["sources"]@propertydefuri(self)->str:
- """URI of the next page, or null if there is no next page."""
+"""URI of the next page, or null if there is no next page."""returnself._props["uri"]
@@ -3335,27 +3924,27 @@
@propertydefid(self)->str:
- """unique identifier for this IP policy"""
+"""unique identifier for this IP policy"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the IP Policy API resource"""
+"""URI of the IP Policy API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the IP policy was created, RFC 3339 format"""
+"""timestamp when the IP policy was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of the source IPs of this IP policy. optional, max 255 bytes."""
+"""human-readable description of the source IPs of this IP policy. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes."""returnself._props["metadata"]
@@ -3383,17 +3972,17 @@
@propertydefip_policies(self)->Sequence[IPPolicy]:
- """the list of all IP policies on this account"""
+"""the list of all IP policies on this account"""returnself._props["ip_policies"]@propertydefuri(self)->str:
- """URI of the IP policy list API resource"""
+"""URI of the IP policy list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -3438,42 +4027,42 @@
@propertydefid(self)->str:
- """unique identifier for this IP policy rule"""
+"""unique identifier for this IP policy rule"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the IP policy rule API resource"""
+"""URI of the IP policy rule API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the IP policy rule was created, RFC 3339 format"""
+"""timestamp when the IP policy rule was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of the source IPs of this IP rule. optional, max 255 bytes."""
+"""human-readable description of the source IPs of this IP rule. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefcidr(self)->str:
- """an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported."""
+"""an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported."""returnself._props["cidr"]@propertydefip_policy(self)->Ref:
- """object describing the IP policy this IP Policy Rule belongs to"""
+"""object describing the IP policy this IP Policy Rule belongs to"""returnself._props["ip_policy"]@propertydefaction(self)->str:
- """the action to apply to the policy rule, either ``allow`` or ``deny``"""
+"""the action to apply to the policy rule, either ``allow`` or ``deny``"""returnself._props["action"]
@@ -3501,17 +4090,17 @@
@propertydefip_policy_rules(self)->Sequence[IPPolicyRule]:
- """the list of all IP policy rules on this account"""
+"""the list of all IP policy rules on this account"""returnself._props["ip_policy_rules"]@propertydefuri(self)->str:
- """URI of the IP policy rule list API resource"""
+"""URI of the IP policy rule list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -3543,42 +4132,42 @@
@propertydefid(self)->str:
- """unique identifier for this IP restriction"""
+"""unique identifier for this IP restriction"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the IP restriction API resource"""
+"""URI of the IP restriction API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the IP restriction was created, RFC 3339 format"""
+"""timestamp when the IP restriction was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this IP restriction. optional, max 255 bytes."""
+"""human-readable description of this IP restriction. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefenforced(self)->bool:
- """true if the IP restriction will be enforced. if false, only warnings will be issued"""
+"""true if the IP restriction will be enforced. if false, only warnings will be issued"""returnself._props["enforced"]@propertydeftype(self)->str:
- """the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``"""
+"""the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``"""returnself._props["type"]@propertydefip_policies(self)->Sequence[Ref]:
- """the set of IP policies that are used to enforce the restriction"""
+"""the set of IP policies that are used to enforce the restriction"""returnself._props["ip_policies"]
@@ -3606,17 +4195,17 @@
@propertydefip_restrictions(self)->Sequence[IPRestriction]:
- """the list of all IP restrictions on this account"""
+"""the list of all IP restrictions on this account"""returnself._props["ip_restrictions"]@propertydefuri(self)->str:
- """URI of the IP restrictions list API resource"""
+"""URI of the IP restrictions list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -3643,37 +4232,37 @@
@propertydefid(self)->str:
- """unique reserved address resource identifier"""
+"""unique reserved address resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the reserved address API resource"""
+"""URI of the reserved address API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the reserved address was created, RFC 3339 format"""
+"""timestamp when the reserved address was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of what this reserved address will be used for"""
+"""human-readable description of what this reserved address will be used for"""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefaddr(self)->str:
- """hostname:port of the reserved address that was assigned at creation time"""
+"""hostname:port of the reserved address that was assigned at creation time"""returnself._props["addr"]@propertydefregion(self)->str:
- """reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"""
+"""reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"""returnself._props["region"]
@@ -3701,17 +4290,17 @@
@propertydefreserved_addrs(self)->Sequence[ReservedAddr]:
- """the list of all reserved addresses on this account"""
+"""the list of all reserved addresses on this account"""returnself._props["reserved_addrs"]@propertydefuri(self)->str:
- """URI of the reserved address list API resource"""
+"""URI of the reserved address list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -3753,62 +4342,62 @@
@propertydefid(self)->str:
- """unique reserved domain resource identifier"""
+"""unique reserved domain resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the reserved domain API resource"""
+"""URI of the reserved domain API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the reserved domain was created, RFC 3339 format"""
+"""timestamp when the reserved domain was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of what this reserved domain will be used for"""
+"""human-readable description of what this reserved domain will be used for"""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefdomain(self)->str:
- """hostname of the reserved domain"""
+"""hostname of the reserved domain"""returnself._props["domain"]@propertydefregion(self)->str:
- """reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"""
+"""reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)"""returnself._props["region"]@propertydefcname_target(self)->str:
- """DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io"""
+"""DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io"""returnself._props["cname_target"]@propertydefcertificate(self)->Ref:
- """object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise."""
+"""object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise."""returnself._props["certificate"]@propertydefcertificate_management_policy(self)->ReservedDomainCertPolicy:
- """configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled"""
+"""configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled"""returnself._props["certificate_management_policy"]@propertydefcertificate_management_status(self)->ReservedDomainCertStatus:
- """status of the automatic certificate management for this domain, or null if automatic management is disabled"""
+"""status of the automatic certificate management for this domain, or null if automatic management is disabled"""returnself._props["certificate_management_status"]@propertydefacme_challenge_cname_target(self)->str:
- """DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains."""
+"""DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains."""returnself._props["acme_challenge_cname_target"]
@@ -3836,17 +4425,17 @@
@propertydefreserved_domains(self)->Sequence[ReservedDomain]:
- """the list of all reserved domains on this account"""
+"""the list of all reserved domains on this account"""returnself._props["reserved_domains"]@propertydefuri(self)->str:
- """URI of the reserved domain list API resource"""
+"""URI of the reserved domain list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -3866,12 +4455,12 @@
@propertydefauthority(self)->str:
- """certificate authority to request certificates from. The only supported value is letsencrypt."""
+"""certificate authority to request certificates from. The only supported value is letsencrypt."""returnself._props["authority"]@propertydefprivate_key_type(self)->str:
- """type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa."""
+"""type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa."""returnself._props["private_key_type"]
@@ -3896,12 +4485,12 @@
@propertydefrenews_at(self)->str:
- """timestamp when the next renewal will be requested, RFC 3339 format"""
+"""timestamp when the next renewal will be requested, RFC 3339 format"""returnself._props["renews_at"]@propertydefprovisioning_job(self)->ReservedDomainCertJob:
- """status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed"""
+"""status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed"""returnself._props["provisioning_job"]
@@ -3921,22 +4510,22 @@
@propertydeferror_code(self)->str:
- """if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR)."""
+"""if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR)."""returnself._props["error_code"]@propertydefmsg(self)->str:
- """a message describing the current status or error"""
+"""a message describing the current status or error"""returnself._props["msg"]@propertydefstarted_at(self)->str:
- """timestamp when the provisioning job started, RFC 3339 format"""
+"""timestamp when the provisioning job started, RFC 3339 format"""returnself._props["started_at"]@propertydefretries_at(self)->str:
- """timestamp when the provisioning job will be retried"""
+"""timestamp when the provisioning job will be retried"""returnself._props["retries_at"]
@@ -3974,37 +4563,37 @@
@propertydefid(self)->str:
- """unique identifier for this SSH Certificate Authority"""
+"""unique identifier for this SSH Certificate Authority"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the SSH Certificate Authority API resource"""
+"""URI of the SSH Certificate Authority API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format"""
+"""timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this SSH Certificate Authority. optional, max 255 bytes."""
+"""human-readable description of this SSH Certificate Authority. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefpublic_key(self)->str:
- """raw public key for this SSH Certificate Authority"""
+"""raw public key for this SSH Certificate Authority"""returnself._props["public_key"]@propertydefkey_type(self)->str:
- """the type of private key for this SSH Certificate Authority"""
+"""the type of private key for this SSH Certificate Authority"""returnself._props["key_type"]
@@ -4037,17 +4626,17 @@
@propertydefssh_certificate_authorities(self)->Sequence[SSHCertificateAuthority]:
- """the list of all certificate authorities on this account"""
+"""the list of all certificate authorities on this account"""returnself._props["ssh_certificate_authorities"]@propertydefuri(self)->str:
- """URI of the certificates authorities list API resource"""
+"""URI of the certificates authorities list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -4087,38 +4676,43 @@
@propertydefid(self)->str:
- """unique ssh credential resource identifier"""
+"""unique ssh credential resource identifier"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the ssh credential API resource"""
+"""URI of the ssh credential API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the ssh credential was created, RFC 3339 format"""
+"""timestamp when the ssh credential was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes."""
+"""human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes."""returnself._props["metadata"]@propertydefpublic_key(self)->str:
- """the PEM-encoded public key of the SSH keypair that will be used to authenticate"""
+"""the PEM-encoded public key of the SSH keypair that will be used to authenticate"""returnself._props["public_key"]@propertydefacl(self)->Sequence[str]:
- """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 and addresses 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 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. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions."""
- returnself._props["acl"]
+"""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."""
+ returnself._props["acl"]
+
+ @property
+ defowner_id(self)->str:
+"""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."""
+ returnself._props["owner_id"]
[docs]classSSHCredentialList(object):
@@ -4145,17 +4739,17 @@
@propertydefssh_credentials(self)->Sequence[SSHCredential]:
- """the list of all ssh credentials on this account"""
+"""the list of all ssh credentials on this account"""returnself._props["ssh_credentials"]@propertydefuri(self)->str:
- """URI of the ssh credential list API resource"""
+"""URI of the ssh credential list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -4193,62 +4787,62 @@
@propertydefid(self)->str:
- """unique identifier for this SSH Host Certificate"""
+"""unique identifier for this SSH Host Certificate"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the SSH Host Certificate API resource"""
+"""URI of the SSH Host Certificate API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the SSH Host Certificate API resource was created, RFC 3339 format"""
+"""timestamp when the SSH Host Certificate API resource was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this SSH Host Certificate. optional, max 255 bytes."""
+"""human-readable description of this SSH Host Certificate. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefpublic_key(self)->str:
- """a public key in OpenSSH Authorized Keys format that this certificate signs"""
+"""a public key in OpenSSH Authorized Keys format that this certificate signs"""returnself._props["public_key"]@propertydefkey_type(self)->str:
- """the key type of the ``public_key``, one of ``rsa``, ``ecdsa`` or ``ed25519``"""
+"""the key type of the ``public_key``, one of ``rsa``, ``ecdsa`` or ``ed25519``"""returnself._props["key_type"]@propertydefssh_certificate_authority_id(self)->str:
- """the ssh certificate authority that is used to sign this ssh host certificate"""
+"""the ssh certificate authority that is used to sign this ssh host certificate"""returnself._props["ssh_certificate_authority_id"]@propertydefprincipals(self)->Sequence[str]:
- """the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts."""
+"""the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts."""returnself._props["principals"]@propertydefvalid_after(self)->str:
- """the time when the ssh host certificate becomes valid, in RFC 3339 format."""
+"""the time when the ssh host certificate becomes valid, in RFC 3339 format."""returnself._props["valid_after"]@propertydefvalid_until(self)->str:
- """the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this ``valid_before``."""
+"""the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this ``valid_before``."""returnself._props["valid_until"]@propertydefcertificate(self)->str:
- """the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a ``-cert.pub`` certificate file on disk that should be referenced in your ``sshd_config`` configuration file with a ``HostCertificate`` directive"""
+"""the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a ``-cert.pub`` certificate file on disk that should be referenced in your ``sshd_config`` configuration file with a ``HostCertificate`` directive"""returnself._props["certificate"]
@@ -4276,17 +4870,17 @@
@propertydefssh_host_certificates(self)->Sequence[SSHHostCertificate]:
- """the list of all ssh host certificates on this account"""
+"""the list of all ssh host certificates on this account"""returnself._props["ssh_host_certificates"]@propertydefuri(self)->str:
- """URI of the ssh host certificates list API resource"""
+"""URI of the ssh host certificates list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -4324,72 +4918,72 @@
@propertydefid(self)->str:
- """unique identifier for this SSH User Certificate"""
+"""unique identifier for this SSH User Certificate"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the SSH User Certificate API resource"""
+"""URI of the SSH User Certificate API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the SSH User Certificate API resource was created, RFC 3339 format"""
+"""timestamp when the SSH User Certificate API resource was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this SSH User Certificate. optional, max 255 bytes."""
+"""human-readable description of this SSH User Certificate. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefpublic_key(self)->str:
- """a public key in OpenSSH Authorized Keys format that this certificate signs"""
+"""a public key in OpenSSH Authorized Keys format that this certificate signs"""returnself._props["public_key"]@propertydefkey_type(self)->str:
- """the key type of the ``public_key``, one of ``rsa``, ``ecdsa`` or ``ed25519``"""
+"""the key type of the ``public_key``, one of ``rsa``, ``ecdsa`` or ``ed25519``"""returnself._props["key_type"]@propertydefssh_certificate_authority_id(self)->str:
- """the ssh certificate authority that is used to sign this ssh user certificate"""
+"""the ssh certificate authority that is used to sign this ssh user certificate"""returnself._props["ssh_certificate_authority_id"]@propertydefprincipals(self)->Sequence[str]:
- """the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user."""
+"""the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user."""returnself._props["principals"]@propertydefcritical_options(self)->Mapping[str,str]:
- """A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""
+"""A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""returnself._props["critical_options"]@propertydefextensions(self)->Mapping[str,str]:
- """A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""
+"""A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""returnself._props["extensions"]@propertydefvalid_after(self)->str:
- """the time when the ssh host certificate becomes valid, in RFC 3339 format."""
+"""the time when the ssh host certificate becomes valid, in RFC 3339 format."""returnself._props["valid_after"]@propertydefvalid_until(self)->str:
- """the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this ``valid_before``."""
+"""the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this ``valid_before``."""returnself._props["valid_until"]@propertydefcertificate(self)->str:
- """the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a ``-cert.pub`` certificate file on disk that should be referenced in your ``sshd_config`` configuration file with a ``HostCertificate`` directive"""
+"""the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a ``-cert.pub`` certificate file on disk that should be referenced in your ``sshd_config`` configuration file with a ``HostCertificate`` directive"""returnself._props["certificate"]
@@ -4417,17 +5011,17 @@
@propertydefssh_user_certificates(self)->Sequence[SSHUserCertificate]:
- """the list of all ssh user certificates on this account"""
+"""the list of all ssh user certificates on this account"""returnself._props["ssh_user_certificates"]@propertydefuri(self)->str:
- """URI of the ssh user certificates list API resource"""
+"""URI of the ssh user certificates list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -4470,107 +5064,107 @@
@propertydefid(self)->str:
- """unique identifier for this TLS certificate"""
+"""unique identifier for this TLS certificate"""returnself._props["id"]@propertydefuri(self)->str:
- """URI of the TLS certificate API resource"""
+"""URI of the TLS certificate API resource"""returnself._props["uri"]@propertydefcreated_at(self)->str:
- """timestamp when the TLS certificate was created, RFC 3339 format"""
+"""timestamp when the TLS certificate was created, RFC 3339 format"""returnself._props["created_at"]@propertydefdescription(self)->str:
- """human-readable description of this TLS certificate. optional, max 255 bytes."""
+"""human-readable description of this TLS certificate. optional, max 255 bytes."""returnself._props["description"]@propertydefmetadata(self)->str:
- """arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes."""
+"""arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes."""returnself._props["metadata"]@propertydefcertificate_pem(self)->str:
- """chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_."""
+"""chain of PEM-encoded certificates, leaf first. See `Certificate Bundles <https://ngrok.com/docs/api#tls-certificates-pem>`_."""returnself._props["certificate_pem"]@propertydefsubject_common_name(self)->str:
- """subject common name from the leaf of this TLS certificate"""
+"""subject common name from the leaf of this TLS certificate"""returnself._props["subject_common_name"]@propertydefsubject_alternative_names(self)->TLSCertificateSANs:
- """subject alternative names (SANs) from the leaf of this TLS certificate"""
+"""subject alternative names (SANs) from the leaf of this TLS certificate"""returnself._props["subject_alternative_names"]@propertydefissued_at(self)->str:
- """timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded"""
+"""timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded"""returnself._props["issued_at"]@propertydefnot_before(self)->str:
- """timestamp when this TLS certificate becomes valid, RFC 3339 format"""
+"""timestamp when this TLS certificate becomes valid, RFC 3339 format"""returnself._props["not_before"]@propertydefnot_after(self)->str:
- """timestamp when this TLS certificate becomes invalid, RFC 3339 format"""
+"""timestamp when this TLS certificate becomes invalid, RFC 3339 format"""returnself._props["not_after"]@propertydefkey_usages(self)->Sequence[str]:
- """set of actions the private key of this TLS certificate can be used for"""
+"""set of actions the private key of this TLS certificate can be used for"""returnself._props["key_usages"]@propertydefextended_key_usages(self)->Sequence[str]:
- """extended set of actions the private key of this TLS certificate can be used for"""
+"""extended set of actions the private key of this TLS certificate can be used for"""returnself._props["extended_key_usages"]@propertydefprivate_key_type(self)->str:
- """type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519."""
+"""type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519."""returnself._props["private_key_type"]@propertydefissuer_common_name(self)->str:
- """issuer common name from the leaf of this TLS certificate"""
+"""issuer common name from the leaf of this TLS certificate"""returnself._props["issuer_common_name"]@propertydefserial_number(self)->str:
- """serial number of the leaf of this TLS certificate"""
+"""serial number of the leaf of this TLS certificate"""returnself._props["serial_number"]@propertydefsubject_organization(self)->str:
- """subject organization from the leaf of this TLS certificate"""
+"""subject organization from the leaf of this TLS certificate"""returnself._props["subject_organization"]@propertydefsubject_organizational_unit(self)->str:
- """subject organizational unit from the leaf of this TLS certificate"""
+"""subject organizational unit from the leaf of this TLS certificate"""returnself._props["subject_organizational_unit"]@propertydefsubject_locality(self)->str:
- """subject locality from the leaf of this TLS certificate"""
+"""subject locality from the leaf of this TLS certificate"""returnself._props["subject_locality"]@propertydefsubject_province(self)->str:
- """subject province from the leaf of this TLS certificate"""
+"""subject province from the leaf of this TLS certificate"""returnself._props["subject_province"]@propertydefsubject_country(self)->str:
- """subject country from the leaf of this TLS certificate"""
+"""subject country from the leaf of this TLS certificate"""returnself._props["subject_country"]
@@ -4598,17 +5192,17 @@
@propertydeftls_certificates(self)->Sequence[TLSCertificate]:
- """the list of all TLS certificates on this account"""
+"""the list of all TLS certificates on this account"""returnself._props["tls_certificates"]@propertydefuri(self)->str:
- """URI of the TLS certificates list API resource"""
+"""URI of the TLS certificates list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -4628,12 +5222,12 @@
@propertydefdns_names(self)->Sequence[str]:
- """set of additional domains (including wildcards) this TLS certificate is valid for"""
+"""set of additional domains (including wildcards) this TLS certificate is valid for"""returnself._props["dns_names"]@propertydefips(self)->Sequence[str]:
- """set of IP addresses this TLS certificate is also valid for"""
+"""set of IP addresses this TLS certificate is also valid for"""returnself._props["ips"]
@@ -4658,52 +5252,52 @@
@propertydefagent_version(self)->str:
- """version of the ngrok agent that started this ngrok tunnel session"""
+"""version of the ngrok agent that started this ngrok tunnel session"""returnself._props["agent_version"]@propertydefcredential(self)->Ref:
- """reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session"""
+"""reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session"""returnself._props["credential"]@propertydefid(self)->str:
- """unique tunnel session resource identifier"""
+"""unique tunnel session resource identifier"""returnself._props["id"]@propertydefip(self)->str:
- """source ip address of the tunnel session"""
+"""source ip address of the tunnel session"""returnself._props["ip"]@propertydefmetadata(self)->str:
- """arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option"""
+"""arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option"""returnself._props["metadata"]@propertydefos(self)->str:
- """operating system of the host the ngrok agent is running on"""
+"""operating system of the host the ngrok agent is running on"""returnself._props["os"]@propertydefregion(self)->str:
- """the ngrok region identifier in which this tunnel session was started"""
+"""the ngrok region identifier in which this tunnel session was started"""returnself._props["region"]@propertydefstarted_at(self)->str:
- """time when the tunnel session first connected to the ngrok servers"""
+"""time when the tunnel session first connected to the ngrok servers"""returnself._props["started_at"]@propertydeftransport(self)->str:
- """the transport protocol used to start the tunnel session. Either ``ngrok/v2`` or ``ssh``"""
+"""the transport protocol used to start the tunnel session. Either ``ngrok/v2`` or ``ssh``"""returnself._props["transport"]@propertydefuri(self)->str:
- """URI to the API resource of the tunnel session"""
+"""URI to the API resource of the tunnel session"""returnself._props["uri"]
@@ -4731,17 +5325,17 @@
@propertydeftunnel_sessions(self)->Sequence[TunnelSession]:
- """list of all tunnel sessions on this account"""
+"""list of all tunnel sessions on this account"""returnself._props["tunnel_sessions"]@propertydefuri(self)->str:
- """URI to the API resource of the tunnel session list"""
+"""URI to the API resource of the tunnel session list"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
@@ -4776,57 +5370,57 @@
@propertydefid(self)->str:
- """unique tunnel resource identifier"""
+"""unique tunnel resource identifier"""returnself._props["id"]@propertydefpublic_url(self)->str:
- """URL of the ephemeral tunnel's public endpoint"""
+"""URL of the ephemeral tunnel's public endpoint"""returnself._props["public_url"]@propertydefstarted_at(self)->str:
- """timestamp when the tunnel was initiated in RFC 3339 format"""
+"""timestamp when the tunnel was initiated in RFC 3339 format"""returnself._props["started_at"]@propertydefmetadata(self)->str:
- """user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option` <https://ngrok.com/docs#tunnel-definitions-metadata>`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option` <https://ngrok.com/docs#config_metadata>`_."""
+"""user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option <https://ngrok.com/docs#tunnel-definitions-metadata>`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option <https://ngrok.com/docs#config_metadata>`_."""returnself._props["metadata"]@propertydefproto(self)->str:
- """tunnel protocol for ephemeral tunnels. one of ``http``, ``https``, ``tcp`` or ``tls``"""
+"""tunnel protocol for ephemeral tunnels. one of ``http``, ``https``, ``tcp`` or ``tls``"""returnself._props["proto"]@propertydefregion(self)->str:
- """identifier of tune region where the tunnel is running"""
+"""identifier of tune region where the tunnel is running"""returnself._props["region"]@propertydeftunnel_session(self)->Ref:
- """reference object pointing to the tunnel session on which this tunnel was started"""
+"""reference object pointing to the tunnel session on which this tunnel was started"""returnself._props["tunnel_session"]@propertydefendpoint(self)->Ref:
- """the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel"""
+"""the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel"""returnself._props["endpoint"]@propertydeflabels(self)->Mapping[str,str]:
- """the labels the tunnel group backends will match against, if this is a backend tunnel"""
+"""the labels the tunnel group backends will match against, if this is a backend tunnel"""returnself._props["labels"]@propertydefbackends(self)->Sequence[Ref]:
- """tunnel group backends served by this backend tunnel"""
+"""tunnel group backends served by this backend tunnel"""returnself._props["backends"]@propertydefforwards_to(self)->str:
- """upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address."""
+"""upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address."""returnself._props["forwards_to"]
@@ -4854,17 +5448,17 @@
@propertydeftunnels(self)->Sequence[Tunnel]:
- """the list of all online tunnels on this account"""
+"""the list of all online tunnels on this account"""returnself._props["tunnels"]@propertydefuri(self)->str:
- """URI of the tunnels list API resource"""
+"""URI of the tunnels list API resource"""returnself._props["uri"]@propertydefnext_page_uri(self)->str:
- """URI of the next page, or null if there is no next page"""
+"""URI of the next page, or null if there is no next page"""returnself._props["next_page_uri"]
diff --git a/docs/_modules/ngrok/error.html b/docs/_modules/ngrok/error.html
index 0049b99..2d050ee 100644
--- a/docs/_modules/ngrok/error.html
+++ b/docs/_modules/ngrok/error.html
@@ -118,6 +118,8 @@
[docs]classError(Exception):
- """Raised by failed ngrok API operations.
+"""Raised by failed ngrok API operations. This class encapsulates details about the error to make it simple for callers to introspect the error and take action on it.
@@ -207,7 +209,7 @@
@propertydefoperation_id(self):
- """
+""" OperationID returns the unique trace ID assigned by ngrok to this API request. """
@@ -215,7 +217,7 @@
[docs]classNotFoundError(Error):
- """Raised if the http_status_code of an API operation is 404.
+"""Raised if the http_status_code of an API operation is 404. This is a separate class to make this common condition easier to handle. """
diff --git a/docs/_modules/ngrok/services.html b/docs/_modules/ngrok/services.html
index 2afa1a8..0f1bf56 100644
--- a/docs/_modules/ngrok/services.html
+++ b/docs/_modules/ngrok/services.html
@@ -118,6 +118,8 @@
[docs]classAbuseReportsClient(object):
- """Abuse Reports allow you to submit take-down requests for URLs hosted by
+"""Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service."""def__init__(self,client):
@@ -199,7 +202,7 @@
urls:Sequence[str],metadata:str="",)->AbuseReport:
- """Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access
+"""Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access :param urls: a list of URLs containing suspected abusive content :param metadata: arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
@@ -218,7 +221,7 @@
self,id:str,)->AbuseReport:
- """Get the detailed status of abuse report by ID.
+"""Get the detailed status of abuse report by ID. :param id: a resource identifier
@@ -243,7 +246,7 @@
description:str="",metadata:str="",)->AgentIngress:
- """Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.
+"""Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress. :param description: human-readable description of the use of this Agent Ingress. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
@@ -264,7 +267,7 @@
self,id:str,):
- """Delete an Agent Ingress by ID
+"""Delete an Agent Ingress by ID :param id: a resource identifier
@@ -281,7 +284,7 @@
self,id:str,)->AgentIngress:
- """Get the details of an Agent Ingress by ID.
+"""Get the details of an Agent Ingress by ID. :param id: a resource identifier
@@ -300,7 +303,7 @@
before_id:str=None,limit:str=None,)->AgentIngressList:
- """List all Agent Ingresses owned by this account
+"""List all Agent Ingresses owned by this account :param before_id: :param limit:
@@ -321,7 +324,7 @@
description:str=None,metadata:str=None,)->AgentIngress:
- """Update attributes of an Agent Ingress by ID.
+"""Update attributes of an Agent Ingress by ID. :param id: :param description: human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
@@ -342,10 +345,10 @@
[docs]classAPIKeysClient(object):
- """API Keys are used to authenticate to the `ngrok
- API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
+"""API Keys are used to authenticate to the `ngrok
+ API <https://ngrok.com/docs/api#authentication>`_. You may use the API itself to provision and manage API Keys but you'll need to provision your first API
- key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your
+ key from the `API Keys page <https://dashboard.ngrok.com/api/keys>`_ on your ngrok.com dashboard."""def__init__(self,client):
@@ -355,11 +358,13 @@
self,description:str="",metadata:str="",
+ owner_id:str=None,)->APIKey:
- """Create a new API key. The generated API key can be used to authenticate to the ngrok API.
+"""Create a new API key. The generated API key can be used to authenticate to the ngrok API. :param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes. :param metadata: arbitrary user-defined data of this API key. optional, max 4096 bytes
+ :param owner_id: 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. https://ngrok.com/docs/api#api-api-keys-create """
@@ -367,6 +372,7 @@
body_arg=dict(description=description,metadata=metadata,
+ owner_id=owner_id,)result=self._client.http_client.post(path,body_arg)returnAPIKey(self._client,result)
@@ -375,7 +381,7 @@
self,id:str,):
- """Delete an API key by ID
+"""Delete an API key by ID :param id: a resource identifier
@@ -392,7 +398,7 @@
self,id:str,)->APIKey:
- """Get the details of an API key by ID.
+"""Get the details of an API key by ID. :param id: a resource identifier
@@ -411,7 +417,7 @@
before_id:str=None,limit:str=None,)->APIKeyList:
- """List all API keys owned by this account
+"""List all API keys owned by this account :param before_id: :param limit:
@@ -432,7 +438,7 @@
description:str=None,metadata:str=None,)->APIKey:
- """Update attributes of an API key by ID.
+"""Update attributes of an API key by ID. :param id: :param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
@@ -452,8 +458,128 @@
returnAPIKey(self._client,result)
[docs]classFailoverBackendsClient(object):
- """A Failover backend defines failover behavior within a list of referenced
+"""A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful."""
@@ -467,7 +593,7 @@
metadata:str="",backends:Sequence[str]=[],)->FailoverBackend:
- """Create a new Failover backend
+"""Create a new Failover backend :param description: human-readable description of this backend. Optional :param metadata: arbitrary user-defined machine-readable data of this backend. Optional
@@ -488,7 +614,7 @@
self,id:str,):
- """Delete a Failover backend by ID.
+"""Delete a Failover backend by ID. :param id: a resource identifier
@@ -505,7 +631,7 @@
self,id:str,)->FailoverBackend:
- """Get detailed information about a Failover backend by ID
+"""Get detailed information about a Failover backend by ID :param id: a resource identifier
@@ -524,7 +650,7 @@
before_id:str=None,limit:str=None,)->FailoverBackendList:
- """List all Failover backends on this account
+"""List all Failover backends on this account :param before_id: :param limit:
@@ -546,7 +672,7 @@
metadata:str=None,backends:Sequence[str]=[],)->FailoverBackend:
- """Update Failover backend by ID
+"""Update Failover backend by ID :param id: :param description: human-readable description of this backend. Optional
@@ -580,7 +706,7 @@
headers:Mapping[str,str]={},status_code:int=None,)->HTTPResponseBackend:
- """
+""" :param description: human-readable description of this backend. Optional :param metadata: arbitrary user-defined machine-readable data of this backend. Optional
@@ -605,7 +731,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -622,7 +748,7 @@
self,id:str,)->HTTPResponseBackend:
- """
+""" :param id: a resource identifier
@@ -641,7 +767,7 @@
before_id:str=None,limit:str=None,)->HTTPResponseBackendList:
- """
+""" :param before_id: :param limit:
@@ -665,7 +791,7 @@
headers:Mapping[str,str]=None,status_code:int=None,)->HTTPResponseBackend:
- """
+""" :param id: :param description: human-readable description of this backend. Optional
@@ -692,7 +818,7 @@
[docs]classTunnelGroupBackendsClient(object):
- """A Tunnel Group Backend balances traffic among all online tunnels that match
+"""A Tunnel Group Backend balances traffic among all online tunnels that match a label selector."""def__init__(self,client):
@@ -704,7 +830,7 @@
metadata:str="",labels:Mapping[str,str]={},)->TunnelGroupBackend:
- """Create a new TunnelGroup backend
+"""Create a new TunnelGroup backend :param description: human-readable description of this backend. Optional :param metadata: arbitrary user-defined machine-readable data of this backend. Optional
@@ -725,7 +851,7 @@
self,id:str,):
- """Delete a TunnelGroup backend by ID.
+"""Delete a TunnelGroup backend by ID. :param id: a resource identifier
@@ -742,7 +868,7 @@
self,id:str,)->TunnelGroupBackend:
- """Get detailed information about a TunnelGroup backend by ID
+"""Get detailed information about a TunnelGroup backend by ID :param id: a resource identifier
@@ -761,7 +887,7 @@
before_id:str=None,limit:str=None,)->TunnelGroupBackendList:
- """List all TunnelGroup backends on this account
+"""List all TunnelGroup backends on this account :param before_id: :param limit:
@@ -783,7 +909,7 @@
metadata:str=None,labels:Mapping[str,str]={},)->TunnelGroupBackend:
- """Update TunnelGroup backend by ID
+"""Update TunnelGroup backend by ID :param id: :param description: human-readable description of this backend. Optional
@@ -806,7 +932,7 @@
[docs]classWeightedBackendsClient(object):
- """A Weighted Backend balances traffic among the referenced backends. Traffic
+"""A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend's weight by the sum of all weights."""
@@ -820,7 +946,7 @@
metadata:str="",backends:Mapping[str,int]={},)->WeightedBackend:
- """Create a new Weighted backend
+"""Create a new Weighted backend :param description: human-readable description of this backend. Optional :param metadata: arbitrary user-defined machine-readable data of this backend. Optional
@@ -841,7 +967,7 @@
self,id:str,):
- """Delete a Weighted backend by ID.
+"""Delete a Weighted backend by ID. :param id: a resource identifier
@@ -858,7 +984,7 @@
self,id:str,)->WeightedBackend:
- """Get detailed information about a Weighted backend by ID
+"""Get detailed information about a Weighted backend by ID :param id: a resource identifier
@@ -877,7 +1003,7 @@
before_id:str=None,limit:str=None,)->WeightedBackendList:
- """List all Weighted backends on this account
+"""List all Weighted backends on this account :param before_id: :param limit:
@@ -899,7 +1025,7 @@
metadata:str=None,backends:Mapping[str,int]={},)->WeightedBackend:
- """Update Weighted backend by ID
+"""Update Weighted backend by ID :param id: :param description: human-readable description of this backend. Optional
@@ -922,7 +1048,7 @@
[docs]classCertificateAuthoritiesClient(object):
- """Certificate Authorities are x509 certificates that are used to sign other
+"""Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and
@@ -937,7 +1063,7 @@
description:str="",metadata:str="",)->CertificateAuthority:
- """Upload a new Certificate Authority
+"""Upload a new Certificate Authority :param description: human-readable description of this Certificate Authority. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
@@ -958,7 +1084,7 @@
self,id:str,):
- """Delete a Certificate Authority
+"""Delete a Certificate Authority :param id: a resource identifier
@@ -975,7 +1101,7 @@
self,id:str,)->CertificateAuthority:
- """Get detailed information about a certficate authority
+"""Get detailed information about a certficate authority :param id: a resource identifier
@@ -994,7 +1120,7 @@
before_id:str=None,limit:str=None,)->CertificateAuthorityList:
- """List all Certificate Authority on this account
+"""List all Certificate Authority on this account :param before_id: :param limit:
@@ -1015,7 +1141,7 @@
description:str=None,metadata:str=None,)->CertificateAuthority:
- """Update attributes of a Certificate Authority by ID
+"""Update attributes of a Certificate Authority by ID :param id: :param description: human-readable description of this Certificate Authority. optional, max 255 bytes.
@@ -1036,7 +1162,7 @@
[docs]classCredentialsClient(object):
- """Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
+"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ``ngrok config add-authtoken`` command or by specifying it in the ``ngrok.yml`` configuration file with the ``authtoken`` property."""
@@ -1049,12 +1175,14 @@
description:str="",metadata:str="",acl:Sequence[str]=[],
+ owner_id:str=None,)->Credential:
- """Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.
+"""Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself. :param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- :param acl: 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 and addresses 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 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. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+ :param acl: 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.
+ :param owner_id: 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. https://ngrok.com/docs/api#api-credentials-create """
@@ -1063,6 +1191,7 @@
description=description,metadata=metadata,acl=acl,
+ owner_id=owner_id,)result=self._client.http_client.post(path,body_arg)returnCredential(self._client,result)
@@ -1071,7 +1200,7 @@
self,id:str,):
- """Delete a tunnel authtoken credential by ID
+"""Delete a tunnel authtoken credential by ID :param id: a resource identifier
@@ -1088,7 +1217,7 @@
self,id:str,)->Credential:
- """Get detailed information about a tunnel authtoken credential
+"""Get detailed information about a tunnel authtoken credential :param id: a resource identifier
@@ -1107,7 +1236,7 @@
before_id:str=None,limit:str=None,)->CredentialList:
- """List all tunnel authtoken credentials on this account
+"""List all tunnel authtoken credentials on this account :param before_id: :param limit:
@@ -1129,12 +1258,12 @@
metadata:str=None,acl:Sequence[str]=None,)->Credential:
- """Update attributes of an tunnel authtoken credential by ID
+"""Update attributes of an tunnel authtoken credential by ID :param id: :param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- :param acl: 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 and addresses 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 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. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+ :param acl: 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. https://ngrok.com/docs/api#api-credentials-update """
@@ -1174,7 +1303,7 @@
oidc:EndpointOIDC=None,websocket_tcp_converter:EndpointWebsocketTCPConverter=None,)->HTTPSEdgeRoute:
- """Create an HTTPS Edge Route
+"""Create an HTTPS Edge Route :param edge_id: unique identifier of this edge :param match_type: Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
@@ -1224,7 +1353,7 @@
edge_id:str,id:str,)->HTTPSEdgeRoute:
- """Get an HTTPS Edge Route by ID
+"""Get an HTTPS Edge Route by ID :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1260,7 +1389,7 @@
oidc:EndpointOIDC=None,websocket_tcp_converter:EndpointWebsocketTCPConverter=None,)->HTTPSEdgeRoute:
- """Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
+"""Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1312,7 +1441,7 @@
edge_id:str,id:str,):
- """Delete an HTTPS Edge Route by ID
+"""Delete an HTTPS Edge Route by ID :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1340,7 +1469,7 @@
mutual_tls:EndpointMutualTLSMutate=None,tls_termination:EndpointTLSTerminationAtEdge=None,)->HTTPSEdge:
- """Create an HTTPS Edge
+"""Create an HTTPS Edge :param description: human-readable description of what this edge will be used for; optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
@@ -1365,7 +1494,7 @@
self,id:str,)->HTTPSEdge:
- """Get an HTTPS Edge by ID
+"""Get an HTTPS Edge by ID :param id: a resource identifier
@@ -1384,7 +1513,7 @@
before_id:str=None,limit:str=None,)->HTTPSEdgeList:
- """Returns a list of all HTTPS Edges on this account
+"""Returns a list of all HTTPS Edges on this account :param before_id: :param limit:
@@ -1408,7 +1537,7 @@
mutual_tls:EndpointMutualTLSMutate=None,tls_termination:EndpointTLSTerminationAtEdge=None,)->HTTPSEdge:
- """Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
+"""Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. :param id: unique identifier of this edge :param description: human-readable description of what this edge will be used for; optional, max 255 bytes.
@@ -1437,7 +1566,7 @@
self,id:str,):
- """Delete an HTTPS Edge by ID
+"""Delete an HTTPS Edge by ID :param id: a resource identifier
@@ -1460,7 +1589,7 @@
id:str,module:EndpointMutualTLSMutate=None,)->EndpointMutualTLS:
- """
+""" :param id: :param module:
@@ -1479,7 +1608,7 @@
self,id:str,)->EndpointMutualTLS:
- """
+""" :param id: a resource identifier
@@ -1497,7 +1626,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -1520,7 +1649,7 @@
id:str,module:EndpointTLSTerminationAtEdge=None,)->EndpointTLSTermination:
- """
+""" :param id: :param module:
@@ -1539,7 +1668,7 @@
self,id:str,)->EndpointTLSTermination:
- """
+""" :param id: a resource identifier
@@ -1557,7 +1686,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -1581,7 +1710,7 @@
id:str,module:EndpointBackendMutate=None,)->EndpointBackend:
- """
+""" :param edge_id: :param id:
@@ -1603,7 +1732,7 @@
edge_id:str,id:str,)->EndpointBackend:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1624,7 +1753,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1650,7 +1779,7 @@
id:str,module:EndpointIPPolicyMutate=None,)->EndpointIPPolicy:
- """
+""" :param edge_id: :param id:
@@ -1672,7 +1801,7 @@
edge_id:str,id:str,)->EndpointIPPolicy:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1693,7 +1822,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1719,7 +1848,7 @@
id:str,module:EndpointRequestHeaders=None,)->EndpointRequestHeaders:
- """
+""" :param edge_id: :param id:
@@ -1741,7 +1870,7 @@
edge_id:str,id:str,)->EndpointRequestHeaders:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1762,7 +1891,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1788,7 +1917,7 @@
id:str,module:EndpointResponseHeaders=None,)->EndpointResponseHeaders:
- """
+""" :param edge_id: :param id:
@@ -1810,7 +1939,7 @@
edge_id:str,id:str,)->EndpointResponseHeaders:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1831,7 +1960,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1857,7 +1986,7 @@
id:str,module:EndpointCompression=None,)->EndpointCompression:
- """
+""" :param edge_id: :param id:
@@ -1879,7 +2008,7 @@
edge_id:str,id:str,)->EndpointCompression:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1900,7 +2029,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1926,7 +2055,7 @@
id:str,module:EndpointCircuitBreaker=None,)->EndpointCircuitBreaker:
- """
+""" :param edge_id: :param id:
@@ -1948,7 +2077,7 @@
edge_id:str,id:str,)->EndpointCircuitBreaker:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1969,7 +2098,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -1995,7 +2124,7 @@
id:str,module:EndpointWebhookValidation=None,)->EndpointWebhookValidation:
- """
+""" :param edge_id: :param id:
@@ -2017,7 +2146,7 @@
edge_id:str,id:str,)->EndpointWebhookValidation:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2038,7 +2167,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2064,7 +2193,7 @@
id:str,module:EndpointOAuth=None,)->EndpointOAuth:
- """
+""" :param edge_id: :param id:
@@ -2086,7 +2215,7 @@
edge_id:str,id:str,)->EndpointOAuth:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2107,7 +2236,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2133,7 +2262,7 @@
id:str,module:EndpointSAMLMutate=None,)->EndpointSAML:
- """
+""" :param edge_id: :param id:
@@ -2155,7 +2284,7 @@
edge_id:str,id:str,)->EndpointSAML:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2176,7 +2305,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2202,7 +2331,7 @@
id:str,module:EndpointOIDC=None,)->EndpointOIDC:
- """
+""" :param edge_id: :param id:
@@ -2224,7 +2353,7 @@
edge_id:str,id:str,)->EndpointOIDC:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2245,7 +2374,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2271,7 +2400,7 @@
id:str,module:EndpointWebsocketTCPConverter=None,)->EndpointWebsocketTCPConverter:
- """
+""" :param edge_id: :param id:
@@ -2293,7 +2422,7 @@
edge_id:str,id:str,)->EndpointWebsocketTCPConverter:
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2314,7 +2443,7 @@
edge_id:str,id:str,):
- """
+""" :param edge_id: unique identifier of this edge :param id: unique identifier of this edge route
@@ -2342,7 +2471,7 @@
backend:EndpointBackendMutate=None,ip_restriction:EndpointIPPolicyMutate=None,)->TCPEdge:
- """Create a TCP Edge
+"""Create a TCP Edge :param description: human-readable description of what this edge will be used for; optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
@@ -2367,7 +2496,7 @@
self,id:str,)->TCPEdge:
- """Get a TCP Edge by ID
+"""Get a TCP Edge by ID :param id: a resource identifier
@@ -2386,7 +2515,7 @@
before_id:str=None,limit:str=None,)->TCPEdgeList:
- """Returns a list of all TCP Edges on this account
+"""Returns a list of all TCP Edges on this account :param before_id: :param limit:
@@ -2410,7 +2539,7 @@
backend:EndpointBackendMutate=None,ip_restriction:EndpointIPPolicyMutate=None,)->TCPEdge:
- """Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
+"""Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. :param id: unique identifier of this edge :param description: human-readable description of what this edge will be used for; optional, max 255 bytes.
@@ -2439,7 +2568,7 @@
self,id:str,):
- """Delete a TCP Edge by ID
+"""Delete a TCP Edge by ID :param id: a resource identifier
@@ -2462,7 +2591,7 @@
id:str,module:EndpointBackendMutate=None,)->EndpointBackend:
- """
+""" :param id: :param module:
@@ -2481,7 +2610,7 @@
self,id:str,)->EndpointBackend:
- """
+""" :param id: a resource identifier
@@ -2499,7 +2628,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -2522,7 +2651,7 @@
id:str,module:EndpointIPPolicyMutate=None,)->EndpointIPPolicy:
- """
+""" :param id: :param module:
@@ -2541,7 +2670,7 @@
self,id:str,)->EndpointIPPolicy:
- """
+""" :param id: a resource identifier
@@ -2559,7 +2688,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -2587,7 +2716,7 @@
mutual_tls:EndpointMutualTLSMutate=None,tls_termination:EndpointTLSTermination=None,)->TLSEdge:
- """Create a TLS Edge
+"""Create a TLS Edge :param description: human-readable description of what this edge will be used for; optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
@@ -2616,7 +2745,7 @@
self,id:str,)->TLSEdge:
- """Get a TLS Edge by ID
+"""Get a TLS Edge by ID :param id: a resource identifier
@@ -2635,7 +2764,7 @@
before_id:str=None,limit:str=None,)->TLSEdgeList:
- """Returns a list of all TLS Edges on this account
+"""Returns a list of all TLS Edges on this account :param before_id: :param limit:
@@ -2661,7 +2790,7 @@
mutual_tls:EndpointMutualTLSMutate=None,tls_termination:EndpointTLSTermination=None,)->TLSEdge:
- """Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
+"""Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. :param id: unique identifier of this edge :param description: human-readable description of what this edge will be used for; optional, max 255 bytes.
@@ -2694,7 +2823,7 @@
self,id:str,):
- """Delete a TLS Edge by ID
+"""Delete a TLS Edge by ID :param id: a resource identifier
@@ -2717,7 +2846,7 @@
id:str,module:EndpointBackendMutate=None,)->EndpointBackend:
- """
+""" :param id: :param module:
@@ -2736,7 +2865,7 @@
self,id:str,)->EndpointBackend:
- """
+""" :param id: a resource identifier
@@ -2754,7 +2883,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -2777,7 +2906,7 @@
id:str,module:EndpointIPPolicyMutate=None,)->EndpointIPPolicy:
- """
+""" :param id: :param module:
@@ -2796,7 +2925,7 @@
self,id:str,)->EndpointIPPolicy:
- """
+""" :param id: a resource identifier
@@ -2814,7 +2943,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -2837,7 +2966,7 @@
id:str,module:EndpointMutualTLSMutate=None,)->EndpointMutualTLS:
- """
+""" :param id: :param module:
@@ -2856,7 +2985,7 @@
self,id:str,)->EndpointMutualTLS:
- """
+""" :param id: a resource identifier
@@ -2874,7 +3003,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -2897,7 +3026,7 @@
id:str,module:EndpointTLSTermination=None,)->EndpointTLSTermination:
- """
+""" :param id: :param module:
@@ -2916,7 +3045,7 @@
self,id:str,)->EndpointTLSTermination:
- """
+""" :param id: a resource identifier
@@ -2934,7 +3063,7 @@
self,id:str,):
- """
+""" :param id: a resource identifier
@@ -2949,7 +3078,7 @@
[docs]classEndpointsClient(object):
- """Endpoints provides an API for querying the endpoint objects
+"""Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned."""
@@ -2961,7 +3090,7 @@
before_id:str=None,limit:str=None,)->EndpointList:
- """List all active endpoints on the account
+"""List all active endpoints on the account :param before_id: :param limit:
@@ -2980,7 +3109,7 @@
self,id:str,)->Endpoint:
- """Get the status of an endpoint by ID
+"""Get the status of an endpoint by ID :param id: a resource identifier
@@ -3006,7 +3135,7 @@
format:str="",target:EventTarget=None,)->EventDestination:
- """Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.
+"""Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription. :param metadata: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes. :param description: Human-readable description of the Event Destination. Optional, max 255 bytes.
@@ -3029,7 +3158,7 @@
self,id:str,):
- """Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
+"""Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription. :param id: a resource identifier
@@ -3046,7 +3175,7 @@
self,id:str,)->EventDestination:
- """Get detailed information about an Event Destination by ID.
+"""Get detailed information about an Event Destination by ID. :param id: a resource identifier
@@ -3065,7 +3194,7 @@
before_id:str=None,limit:str=None,)->EventDestinationList:
- """List all Event Destinations on this account.
+"""List all Event Destinations on this account. :param before_id: :param limit:
@@ -3088,7 +3217,7 @@
format:str=None,target:EventTarget=None,)->EventDestination:
- """Update attributes of an Event Destination.
+"""Update attributes of an Event Destination. :param id: Unique identifier for this Event Destination. :param metadata: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
@@ -3123,7 +3252,7 @@
sources:Sequence[EventSourceReplace]=[],destination_ids:Sequence[str]=[],)->EventSubscription:
- """Create an Event Subscription.
+"""Create an Event Subscription. :param metadata: Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars. :param description: Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
@@ -3146,7 +3275,7 @@
self,id:str,):
- """Delete an Event Subscription.
+"""Delete an Event Subscription. :param id: a resource identifier
@@ -3163,7 +3292,7 @@
self,id:str,)->EventSubscription:
- """Get an Event Subscription by ID.
+"""Get an Event Subscription by ID. :param id: a resource identifier
@@ -3182,7 +3311,7 @@
before_id:str=None,limit:str=None,)->EventSubscriptionList:
- """List this Account's Event Subscriptions.
+"""List this Account's Event Subscriptions. :param before_id: :param limit:
@@ -3205,7 +3334,7 @@
sources:Sequence[EventSourceReplace]=None,destination_ids:Sequence[str]=None,)->EventSubscription:
- """Update an Event Subscription.
+"""Update an Event Subscription. :param id: Unique identifier for this Event Subscription. :param metadata: Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
@@ -3238,7 +3367,7 @@
subscription_id:str,type:str="",)->EventSource:
- """Add an additional type for which this event subscription will trigger
+"""Add an additional type for which this event subscription will trigger :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to. :param type: Type of event for which an event subscription will trigger
@@ -3260,7 +3389,7 @@
subscription_id:str,type:str,):
- """Remove a type for which this event subscription will trigger
+"""Remove a type for which this event subscription will trigger :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to. :param type: Type of event for which an event subscription will trigger
@@ -3280,7 +3409,7 @@
subscription_id:str,type:str,)->EventSource:
- """Get the details for a given type that triggers for the given event subscription
+"""Get the details for a given type that triggers for the given event subscription :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to. :param type: Type of event for which an event subscription will trigger
@@ -3300,7 +3429,7 @@
self,subscription_id:str,)->EventSourceList:
- """List the types for which this event subscription will trigger
+"""List the types for which this event subscription will trigger :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to.
@@ -3319,7 +3448,7 @@
subscription_id:str,type:str,)->EventSource:
- """Update the type for which this event subscription will trigger
+"""Update the type for which this event subscription will trigger :param subscription_id: The unique identifier for the Event Subscription that this Event Source is attached to. :param type: Type of event for which an event subscription will trigger
@@ -3337,7 +3466,7 @@
[docs]classIPPoliciesClient(object):
- """IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``
+"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny`` action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard."""
@@ -3350,7 +3479,7 @@
description:str="",metadata:str="",)->IPPolicy:
- """Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.
+"""Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction. :param description: human-readable description of the source IPs of this IP policy. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
@@ -3369,7 +3498,7 @@
self,id:str,):
- """Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.
+"""Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules. :param id: a resource identifier
@@ -3386,7 +3515,7 @@
self,id:str,)->IPPolicy:
- """Get detailed information about an IP policy by ID.
+"""Get detailed information about an IP policy by ID. :param id: a resource identifier
@@ -3405,7 +3534,7 @@
before_id:str=None,limit:str=None,)->IPPolicyList:
- """List all IP policies on this account
+"""List all IP policies on this account :param before_id: :param limit:
@@ -3426,7 +3555,7 @@
description:str=None,metadata:str=None,)->IPPolicy:
- """Update attributes of an IP policy by ID
+"""Update attributes of an IP policy by ID :param id: :param description: human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
@@ -3447,7 +3576,7 @@
[docs]classIPPolicyRulesClient(object):
- """IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy."""def__init__(self,client):
@@ -3461,7 +3590,7 @@
description:str="",metadata:str="",)->IPPolicyRule:
- """Create a new IP policy rule attached to an IP Policy.
+"""Create a new IP policy rule attached to an IP Policy. :param description: human-readable description of the source IPs of this IP rule. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
@@ -3486,7 +3615,7 @@
self,id:str,):
- """Delete an IP policy rule.
+"""Delete an IP policy rule. :param id: a resource identifier
@@ -3503,7 +3632,7 @@
self,id:str,)->IPPolicyRule:
- """Get detailed information about an IP policy rule by ID.
+"""Get detailed information about an IP policy rule by ID. :param id: a resource identifier
@@ -3522,7 +3651,7 @@
before_id:str=None,limit:str=None,)->IPPolicyRuleList:
- """List all IP policy rules on this account
+"""List all IP policy rules on this account :param before_id: :param limit:
@@ -3544,7 +3673,7 @@
metadata:str=None,cidr:str=None,)->IPPolicyRule:
- """Update attributes of an IP policy rule by ID
+"""Update attributes of an IP policy rule by ID :param id: :param description: human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
@@ -3567,7 +3696,7 @@
[docs]classIPRestrictionsClient(object):
- """An IP restriction is a restriction placed on the CIDRs that are allowed to
+"""An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API
@@ -3585,7 +3714,7 @@
metadata:str="",enforced:bool=False,)->IPRestriction:
- """Create a new IP restriction
+"""Create a new IP restriction :param description: human-readable description of this IP restriction. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
@@ -3610,7 +3739,7 @@
self,id:str,):
- """Delete an IP restriction
+"""Delete an IP restriction :param id: a resource identifier
@@ -3627,7 +3756,7 @@
self,id:str,)->IPRestriction:
- """Get detailed information about an IP restriction
+"""Get detailed information about an IP restriction :param id: a resource identifier
@@ -3646,7 +3775,7 @@
before_id:str=None,limit:str=None,)->IPRestrictionList:
- """List all IP restrictions on this account
+"""List all IP restrictions on this account :param before_id: :param limit:
@@ -3669,7 +3798,7 @@
enforced:bool=None,ip_policy_ids:Sequence[str]=[],)->IPRestriction:
- """Update attributes of an IP restriction by ID
+"""Update attributes of an IP restriction by ID :param id: :param description: human-readable description of this IP restriction. optional, max 255 bytes.
@@ -3694,7 +3823,7 @@
[docs]classReservedAddrsClient(object):
- """Reserved Addresses are TCP addresses that can be used to listen for traffic.
+"""Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen."""
@@ -3707,7 +3836,7 @@
metadata:str="",region:str="",)->ReservedAddr:
- """Create a new reserved address.
+"""Create a new reserved address. :param description: human-readable description of what this reserved address will be used for :param metadata: arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
@@ -3728,7 +3857,7 @@
self,id:str,):
- """Delete a reserved address.
+"""Delete a reserved address. :param id: a resource identifier
@@ -3745,7 +3874,7 @@
self,id:str,)->ReservedAddr:
- """Get the details of a reserved address.
+"""Get the details of a reserved address. :param id: a resource identifier
@@ -3764,7 +3893,7 @@
before_id:str=None,limit:str=None,)->ReservedAddrList:
- """List all reserved addresses on this account.
+"""List all reserved addresses on this account. :param before_id: :param limit:
@@ -3785,7 +3914,7 @@
description:str=None,metadata:str=None,)->ReservedAddr:
- """Update the attributes of a reserved address.
+"""Update the attributes of a reserved address. :param id: :param description: human-readable description of what this reserved address will be used for
@@ -3806,7 +3935,7 @@
[docs]classReservedDomainsClient(object):
- """Reserved Domains are hostnames that you can listen for traffic on. Domains
+"""Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers."""
@@ -3816,16 +3945,18 @@
[docs]defcreate(self,
- name:str,
+ name:str="",
+ domain:str="",region:str="",description:str="",metadata:str="",certificate_id:str=None,certificate_management_policy:ReservedDomainCertPolicy=None,)->ReservedDomain:
- """Create a new reserved domain.
+"""Create a new reserved domain. :param name: the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
+ :param domain: hostname of the reserved domain :param region: reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) :param description: human-readable description of what this reserved domain will be used for :param metadata: arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
@@ -3837,6 +3968,7 @@
path="/reserved_domains"body_arg=dict(name=name,
+ domain=domain,region=region,description=description,metadata=metadata,
@@ -3850,7 +3982,7 @@
self,id:str,):
- """Delete a reserved domain.
+"""Delete a reserved domain. :param id: a resource identifier
@@ -3867,7 +3999,7 @@
self,id:str,)->ReservedDomain:
- """Get the details of a reserved domain.
+"""Get the details of a reserved domain. :param id: a resource identifier
@@ -3886,7 +4018,7 @@
before_id:str=None,limit:str=None,)->ReservedDomainList:
- """List all reserved domains on this account.
+"""List all reserved domains on this account. :param before_id: :param limit:
@@ -3909,7 +4041,7 @@
certificate_id:str=None,certificate_management_policy:ReservedDomainCertPolicy=None,)->ReservedDomain:
- """Update the attributes of a reserved domain.
+"""Update the attributes of a reserved domain. :param id: :param description: human-readable description of what this reserved domain will be used for
@@ -3936,7 +4068,7 @@
self,id:str,):
- """Detach the certificate management policy attached to a reserved domain.
+"""Detach the certificate management policy attached to a reserved domain. :param id: a resource identifier
@@ -3953,7 +4085,7 @@
self,id:str,):
- """Detach the certificate attached to a reserved domain.
+"""Detach the certificate attached to a reserved domain. :param id: a resource identifier
@@ -3968,7 +4100,7 @@
[docs]classSSHCertificateAuthoritiesClient(object):
- """An SSH Certificate Authority is a pair of an SSH Certificate and its private
+"""An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates."""def__init__(self,client):
@@ -3982,7 +4114,7 @@
elliptic_curve:str="",key_size:int=0,)->SSHCertificateAuthority:
- """Create a new SSH Certificate Authority
+"""Create a new SSH Certificate Authority :param description: human-readable description of this SSH Certificate Authority. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
@@ -4007,7 +4139,7 @@
self,id:str,):
- """Delete an SSH Certificate Authority
+"""Delete an SSH Certificate Authority :param id: a resource identifier
@@ -4024,7 +4156,7 @@
self,id:str,)->SSHCertificateAuthority:
- """Get detailed information about an SSH Certficate Authority
+"""Get detailed information about an SSH Certficate Authority :param id: a resource identifier
@@ -4043,7 +4175,7 @@
before_id:str=None,limit:str=None,)->SSHCertificateAuthorityList:
- """List all SSH Certificate Authorities on this account
+"""List all SSH Certificate Authorities on this account :param before_id: :param limit:
@@ -4064,7 +4196,7 @@
description:str=None,metadata:str=None,)->SSHCertificateAuthority:
- """Update an SSH Certificate Authority
+"""Update an SSH Certificate Authority :param id: :param description: human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
@@ -4085,7 +4217,7 @@
[docs]classSSHCredentialsClient(object):
- """SSH Credentials are SSH public keys that can be used to start SSH tunnels
+"""SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway."""def__init__(self,client):
@@ -4097,13 +4229,15 @@
description:str="",metadata:str="",acl:Sequence[str]=[],
+ owner_id:str=None,)->SSHCredential:
- """Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.
+"""Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway. :param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
- :param acl: 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 and addresses 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 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. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+ :param acl: 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. :param public_key: the PEM-encoded public key of the SSH keypair that will be used to authenticate
+ :param owner_id: 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. https://ngrok.com/docs/api#api-ssh-credentials-create """
@@ -4113,6 +4247,7 @@
metadata=metadata,acl=acl,public_key=public_key,
+ owner_id=owner_id,)result=self._client.http_client.post(path,body_arg)returnSSHCredential(self._client,result)
@@ -4121,7 +4256,7 @@
self,id:str,):
- """Delete an ssh_credential by ID
+"""Delete an ssh_credential by ID :param id: a resource identifier
@@ -4138,7 +4273,7 @@
self,id:str,)->SSHCredential:
- """Get detailed information about an ssh_credential
+"""Get detailed information about an ssh_credential :param id: a resource identifier
@@ -4157,7 +4292,7 @@
before_id:str=None,limit:str=None,)->SSHCredentialList:
- """List all ssh credentials on this account
+"""List all ssh credentials on this account :param before_id: :param limit:
@@ -4179,12 +4314,12 @@
metadata:str=None,acl:Sequence[str]=None,)->SSHCredential:
- """Update attributes of an ssh_credential by ID
+"""Update attributes of an ssh_credential by ID :param id: :param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
- :param acl: 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 and addresses 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 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. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+ :param acl: 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. https://ngrok.com/docs/api#api-ssh-credentials-update """
@@ -4202,7 +4337,7 @@
[docs]classSSHHostCertificatesClient(object):
- """SSH Host Certificates along with the corresponding private key allows an SSH
+"""SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate."""
@@ -4219,7 +4354,7 @@
description:str="",metadata:str="",)->SSHHostCertificate:
- """Create a new SSH Host Certificate
+"""Create a new SSH Host Certificate :param ssh_certificate_authority_id: the ssh certificate authority that is used to sign this ssh host certificate :param public_key: a public key in OpenSSH Authorized Keys format that this certificate signs
@@ -4248,7 +4383,7 @@
self,id:str,):
- """Delete an SSH Host Certificate
+"""Delete an SSH Host Certificate :param id: a resource identifier
@@ -4265,7 +4400,7 @@
self,id:str,)->SSHHostCertificate:
- """Get detailed information about an SSH Host Certficate
+"""Get detailed information about an SSH Host Certficate :param id: a resource identifier
@@ -4284,7 +4419,7 @@
before_id:str=None,limit:str=None,)->SSHHostCertificateList:
- """List all SSH Host Certificates issued on this account
+"""List all SSH Host Certificates issued on this account :param before_id: :param limit:
@@ -4305,7 +4440,7 @@
description:str=None,metadata:str=None,)->SSHHostCertificate:
- """Update an SSH Host Certificate
+"""Update an SSH Host Certificate :param id: :param description: human-readable description of this SSH Host Certificate. optional, max 255 bytes.
@@ -4326,7 +4461,7 @@
[docs]classSSHUserCertificatesClient(object):
- """SSH User Certificates are presented by SSH clients when connecting to an SSH
+"""SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate."""
@@ -4345,13 +4480,13 @@
description:str="",metadata:str="",)->SSHUserCertificate:
- """Create a new SSH User Certificate
+"""Create a new SSH User Certificate :param ssh_certificate_authority_id: the ssh certificate authority that is used to sign this ssh user certificate :param public_key: a public key in OpenSSH Authorized Keys format that this certificate signs :param principals: the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
- :param critical_options: A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
- :param extensions: A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
+ :param critical_options: A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
+ :param extensions: A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details. :param valid_after: The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified. :param valid_until: The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this ``valid_before``. :param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.
@@ -4378,7 +4513,7 @@
self,id:str,):
- """Delete an SSH User Certificate
+"""Delete an SSH User Certificate :param id: a resource identifier
@@ -4395,7 +4530,7 @@
self,id:str,)->SSHUserCertificate:
- """Get detailed information about an SSH User Certficate
+"""Get detailed information about an SSH User Certficate :param id: a resource identifier
@@ -4414,7 +4549,7 @@
before_id:str=None,limit:str=None,)->SSHUserCertificateList:
- """List all SSH User Certificates issued on this account
+"""List all SSH User Certificates issued on this account :param before_id: :param limit:
@@ -4435,7 +4570,7 @@
description:str=None,metadata:str=None,)->SSHUserCertificate:
- """Update an SSH User Certificate
+"""Update an SSH User Certificate :param id: :param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.
@@ -4456,7 +4591,7 @@
[docs]classTLSCertificatesClient(object):
- """TLS Certificates are pairs of x509 certificates and their matching private
+"""TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled
@@ -4472,12 +4607,12 @@
description:str="",metadata:str="",)->TLSCertificate:
- """Upload a new TLS certificate
+"""Upload a new TLS certificate :param description: human-readable description of this TLS certificate. optional, max 255 bytes. :param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
- :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_.
- :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys` <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_.
+ :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles <https://ngrok.com/docs/api#tls-certificates-pem>`_.
+ :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_. https://ngrok.com/docs/api#api-tls-certificates-create """
@@ -4495,7 +4630,7 @@
self,id:str,):
- """Delete a TLS certificate
+"""Delete a TLS certificate :param id: a resource identifier
@@ -4512,7 +4647,7 @@
self,id:str,)->TLSCertificate:
- """Get detailed information about a TLS certificate
+"""Get detailed information about a TLS certificate :param id: a resource identifier
@@ -4531,7 +4666,7 @@
before_id:str=None,limit:str=None,)->TLSCertificateList:
- """List all TLS certificates on this account
+"""List all TLS certificates on this account :param before_id: :param limit:
@@ -4552,7 +4687,7 @@
description:str=None,metadata:str=None,)->TLSCertificate:
- """Update attributes of a TLS Certificate by ID
+"""Update attributes of a TLS Certificate by ID :param id: :param description: human-readable description of this TLS certificate. optional, max 255 bytes.
@@ -4573,7 +4708,7 @@
[docs]classTunnelSessionsClient(object):
- """Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels."""
@@ -4585,7 +4720,7 @@
before_id:str=None,limit:str=None,)->TunnelSessionList:
- """List all online tunnel sessions running on this account.
+"""List all online tunnel sessions running on this account. :param before_id: :param limit:
@@ -4604,7 +4739,7 @@
self,id:str,)->TunnelSession:
- """Get the detailed status of a tunnel session by ID
+"""Get the detailed status of a tunnel session by ID :param id: a resource identifier
@@ -4622,7 +4757,7 @@
self,id:str,):
- """Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.
+"""Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID. :param id: a resource identifier
@@ -4639,7 +4774,7 @@
self,id:str,):
- """Issues a command instructing the ngrok agent that started this tunnel session to exit.
+"""Issues a command instructing the ngrok agent that started this tunnel session to exit. :param id: a resource identifier
@@ -4656,7 +4791,7 @@
self,id:str,):
- """Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted
+"""Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted :param id:
@@ -4671,7 +4806,7 @@
API Keys are used to authenticate to the ngrok
+API. You may use the API itself
to provision and manage API Keys but you’ll need to provision your first API
-key from the API Keys page <https://dashboard.ngrok.com/api/keys>`_ on your
+key from the API Keys page on your
ngrok.com dashboard.
Create a new API key. The generated API key can be used to authenticate to the ngrok API.
Parameters
description (str) – human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
metadata (str) – arbitrary user-defined data of this API key. optional, max 4096 bytes
+
owner_id (Optional[str]) – 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.