diff --git a/.tox/dist/ngrok-api-0.0.0.zip b/.tox/dist/ngrok-api-0.0.0.zip deleted file mode 100644 index 52f0091..0000000 Binary files a/.tox/dist/ngrok-api-0.0.0.zip and /dev/null differ diff --git a/.tox/dist/ngrok_api-0.0.0.zip b/.tox/dist/ngrok_api-0.0.0.zip new file mode 100644 index 0000000..cd52f95 Binary files /dev/null and b/.tox/dist/ngrok_api-0.0.0.zip differ diff --git a/.tox/log/GLOB-0.log b/.tox/log/GLOB-0.log index d49437a..1e6b691 100644 --- a/.tox/log/GLOB-0.log +++ b/.tox/log/GLOB-0.log @@ -1,6 +1,6 @@ action: GLOB, msg: packaging -cwd: /var/lib/buildkite-agent-0/builds/repo-ngrok-private-ngrok-buildkite-agent-0/.cache/ngrok-api-python -cmd: /var/lib/buildkite-agent-0/builds/repo-ngrok-private-ngrok-buildkite-agent-0/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist +cwd: /var/lib/buildkite-agent-1/builds/repo-ngrok-private-ngrok-buildkite-agent-1/.cache/ngrok-api-python +cmd: /var/lib/buildkite-agent-1/builds/repo-ngrok-private-ngrok-buildkite-agent-1/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist running sdist running egg_info writing ngrok_api.egg-info/PKG-INFO @@ -11,53 +11,54 @@ reading manifest file 'ngrok_api.egg-info/SOURCES.txt' adding license file 'LICENSE' writing manifest file 'ngrok_api.egg-info/SOURCES.txt' running check -creating ngrok-api-0.0.0 -creating ngrok-api-0.0.0/ngrok -creating ngrok-api-0.0.0/ngrok_api.egg-info -creating ngrok-api-0.0.0/tests -copying files to ngrok-api-0.0.0... -copying LICENSE -> ngrok-api-0.0.0 -copying README.md -> ngrok-api-0.0.0 -copying pyproject.toml -> ngrok-api-0.0.0 -copying setup.py -> ngrok-api-0.0.0 -copying ngrok/__init__.py -> ngrok-api-0.0.0/ngrok -copying ngrok/client.py -> ngrok-api-0.0.0/ngrok -copying ngrok/datatypes.py -> ngrok-api-0.0.0/ngrok -copying ngrok/error.py -> ngrok-api-0.0.0/ngrok -copying ngrok/http_client.py -> ngrok-api-0.0.0/ngrok -copying ngrok/iterator.py -> ngrok-api-0.0.0/ngrok -copying ngrok/services.py -> ngrok-api-0.0.0/ngrok -copying ngrok/utils.py -> ngrok-api-0.0.0/ngrok -copying ngrok_api.egg-info/PKG-INFO -> ngrok-api-0.0.0/ngrok_api.egg-info -copying ngrok_api.egg-info/SOURCES.txt -> ngrok-api-0.0.0/ngrok_api.egg-info -copying ngrok_api.egg-info/dependency_links.txt -> ngrok-api-0.0.0/ngrok_api.egg-info -copying ngrok_api.egg-info/requires.txt -> ngrok-api-0.0.0/ngrok_api.egg-info -copying ngrok_api.egg-info/top_level.txt -> ngrok-api-0.0.0/ngrok_api.egg-info -copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests -Writing ngrok-api-0.0.0/setup.cfg -creating '.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it -adding 'ngrok-api-0.0.0' -adding 'ngrok-api-0.0.0/ngrok_api.egg-info' -adding 'ngrok-api-0.0.0/ngrok' -adding 'ngrok-api-0.0.0/tests' -adding 'ngrok-api-0.0.0/LICENSE' -adding 'ngrok-api-0.0.0/setup.cfg' -adding 'ngrok-api-0.0.0/pyproject.toml' -adding 'ngrok-api-0.0.0/PKG-INFO' -adding 'ngrok-api-0.0.0/setup.py' -adding 'ngrok-api-0.0.0/README.md' -adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt' -adding 'ngrok-api-0.0.0/ngrok_api.egg-info/PKG-INFO' -adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.txt' -adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt' -adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.txt' -adding 'ngrok-api-0.0.0/ngrok/error.py' -adding 'ngrok-api-0.0.0/ngrok/datatypes.py' -adding 'ngrok-api-0.0.0/ngrok/http_client.py' -adding 'ngrok-api-0.0.0/ngrok/iterator.py' -adding 'ngrok-api-0.0.0/ngrok/services.py' -adding 'ngrok-api-0.0.0/ngrok/__init__.py' -adding 'ngrok-api-0.0.0/ngrok/utils.py' -adding 'ngrok-api-0.0.0/ngrok/client.py' -adding 'ngrok-api-0.0.0/tests/test_ngrok.py' -removing 'ngrok-api-0.0.0' (and everything under it) +creating ngrok_api-0.0.0 +creating ngrok_api-0.0.0/ngrok +creating ngrok_api-0.0.0/ngrok_api.egg-info +creating ngrok_api-0.0.0/tests +copying files to ngrok_api-0.0.0... +copying LICENSE -> ngrok_api-0.0.0 +copying README.md -> ngrok_api-0.0.0 +copying pyproject.toml -> ngrok_api-0.0.0 +copying setup.py -> ngrok_api-0.0.0 +copying ngrok/__init__.py -> ngrok_api-0.0.0/ngrok +copying ngrok/client.py -> ngrok_api-0.0.0/ngrok +copying ngrok/datatypes.py -> ngrok_api-0.0.0/ngrok +copying ngrok/error.py -> ngrok_api-0.0.0/ngrok +copying ngrok/http_client.py -> ngrok_api-0.0.0/ngrok +copying ngrok/iterator.py -> ngrok_api-0.0.0/ngrok +copying ngrok/services.py -> ngrok_api-0.0.0/ngrok +copying ngrok/utils.py -> ngrok_api-0.0.0/ngrok +copying ngrok_api.egg-info/PKG-INFO -> ngrok_api-0.0.0/ngrok_api.egg-info +copying ngrok_api.egg-info/SOURCES.txt -> ngrok_api-0.0.0/ngrok_api.egg-info +copying ngrok_api.egg-info/dependency_links.txt -> ngrok_api-0.0.0/ngrok_api.egg-info +copying ngrok_api.egg-info/requires.txt -> ngrok_api-0.0.0/ngrok_api.egg-info +copying ngrok_api.egg-info/top_level.txt -> ngrok_api-0.0.0/ngrok_api.egg-info +copying tests/test_ngrok.py -> ngrok_api-0.0.0/tests +copying ngrok_api.egg-info/SOURCES.txt -> ngrok_api-0.0.0/ngrok_api.egg-info +Writing ngrok_api-0.0.0/setup.cfg +creating '.tox/dist/ngrok_api-0.0.0.zip' and adding 'ngrok_api-0.0.0' to it +adding 'ngrok_api-0.0.0' +adding 'ngrok_api-0.0.0/ngrok_api.egg-info' +adding 'ngrok_api-0.0.0/tests' +adding 'ngrok_api-0.0.0/ngrok' +adding 'ngrok_api-0.0.0/pyproject.toml' +adding 'ngrok_api-0.0.0/PKG-INFO' +adding 'ngrok_api-0.0.0/setup.py' +adding 'ngrok_api-0.0.0/setup.cfg' +adding 'ngrok_api-0.0.0/README.md' +adding 'ngrok_api-0.0.0/LICENSE' +adding 'ngrok_api-0.0.0/ngrok_api.egg-info/SOURCES.txt' +adding 'ngrok_api-0.0.0/ngrok_api.egg-info/PKG-INFO' +adding 'ngrok_api-0.0.0/ngrok_api.egg-info/top_level.txt' +adding 'ngrok_api-0.0.0/ngrok_api.egg-info/requires.txt' +adding 'ngrok_api-0.0.0/ngrok_api.egg-info/dependency_links.txt' +adding 'ngrok_api-0.0.0/tests/test_ngrok.py' +adding 'ngrok_api-0.0.0/ngrok/utils.py' +adding 'ngrok_api-0.0.0/ngrok/datatypes.py' +adding 'ngrok_api-0.0.0/ngrok/__init__.py' +adding 'ngrok_api-0.0.0/ngrok/http_client.py' +adding 'ngrok_api-0.0.0/ngrok/iterator.py' +adding 'ngrok_api-0.0.0/ngrok/error.py' +adding 'ngrok_api-0.0.0/ngrok/services.py' +adding 'ngrok_api-0.0.0/ngrok/client.py' +removing 'ngrok_api-0.0.0' (and everything under it) diff --git a/CHANGELOG.md b/CHANGELOG.md index 86151d3..ba68d81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ +## 0.13.0 +* Added support for Cloud Endpoints (currently in private beta). + ## 0.12.0 * Renamed the Policy Module to the Traffic Policy Module on HTTP Edge Routes, TCP Edges, and TLS Edges, which allows you to configure rules that can be used to influence and control traffic to and from your upstream service. The Traffic Policy itself is now specified as either a JSON or YAML string. diff --git a/docs/_modules/ngrok/client.html b/docs/_modules/ngrok/client.html index 50d7e0e..d7de130 100644 --- a/docs/_modules/ngrok/client.html +++ b/docs/_modules/ngrok/client.html @@ -475,12 +475,15 @@ "https_edge_route_oidc", "https_edge_route_websocket_tcp_converter", "https_edge_route_user_agent_filter", + "https_edge_route_traffic_policy", "tcp_edge_backend", "tcp_edge_ip_restriction", + "tcp_edge_traffic_policy", "tls_edge_backend", "tls_edge_ip_restriction", "tls_edge_mutual_tls", "tls_edge_tls_termination", + "tls_edge_traffic_policy", ], ) return ns( @@ -506,12 +509,15 @@ https_edge_route_user_agent_filter=EdgeRouteUserAgentFilterModuleClient( self ), + https_edge_route_traffic_policy=EdgeRouteTrafficPolicyModuleClient(self), tcp_edge_backend=TCPEdgeBackendModuleClient(self), tcp_edge_ip_restriction=TCPEdgeIPRestrictionModuleClient(self), + tcp_edge_traffic_policy=TCPEdgeTrafficPolicyModuleClient(self), tls_edge_backend=TLSEdgeBackendModuleClient(self), tls_edge_ip_restriction=TLSEdgeIPRestrictionModuleClient(self), tls_edge_mutual_tls=TLSEdgeMutualTLSModuleClient(self), tls_edge_tls_termination=TLSEdgeTLSTerminationModuleClient(self), + tls_edge_traffic_policy=TLSEdgeTrafficPolicyModuleClient(self), ) diff --git a/docs/_modules/ngrok/datatypes.html b/docs/_modules/ngrok/datatypes.html index a90d9ae..65c1e57 100644 --- a/docs/_modules/ngrok/datatypes.html +++ b/docs/_modules/ngrok/datatypes.html @@ -3912,6 +3912,21 @@ self._props["edge"] = ( Ref(client, props["edge"]) if props.get("edge") is not None else None ) + self._props["principal"] = ( + Ref(client, props["principal"]) + if props.get("principal") is not None + else None + ) + self._props["principal_id"] = ( + Ref(client, props["principal_id"]) + if props.get("principal_id") is not None + else None + ) + self._props["tunnel_session"] = ( + Ref(client, props["tunnel_session"]) + if props.get("tunnel_session") is not None + else None + ) def __eq__(self, other): return self._props == other._props @@ -3922,6 +3937,30 @@ else: return "<Endpoint {}>".format(repr(self._props)) +
the bindings associated with this endpoint
+Sequence[str]
timestamp when the endpoint was created in RFC 3339 format
@@ -1632,6 +1643,22 @@user-supplied description of the associated tunnel
+str
str
hostport served by this endpoint (hostname:port)
+hostport served by this endpoint (hostname:port) -> soon to be deprecated
str
user supplied name for the endpoint
+str
int
The ID of the owner (bot or user) that owns this endpoint
+str
The traffic policy attached to this endpoint
+str
The tunnel session of the agent for this endpoint
+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) or cloud (represents a cloud endpoint)
str
the protocol the agent uses to forward with
+str
the local address the tunnel forwards to
+str
URI of the clep API resource
+str
the url of the endpoint
+str
Data collection stream name to use as destination, located instide the DCR
+Data collection stream name to use as destination, located inside the DCR
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 ecdsa, can be either rsa or ecdsa.
str
EndpointEndpoint.bindingsEndpoint.created_atEndpoint.delete()Endpoint.descriptionEndpoint.domainEndpoint.edgeEndpoint.hostEndpoint.hostportEndpoint.idEndpoint.metadataEndpoint.nameEndpoint.portEndpoint.principalEndpoint.principal_idEndpoint.protoEndpoint.public_urlEndpoint.regionEndpoint.schemeEndpoint.tcp_addrEndpoint.traffic_policyEndpoint.tunnelEndpoint.tunnel_sessionEndpoint.typeEndpoint.update()Endpoint.updated_atEndpoint.upstream_protoEndpoint.upstream_urlEndpoint.uriEndpoint.urlEndpointBackendEndpoints 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.
+Create an endpoint, currently available only for cloud endpoints
+url (str) – the url of the endpoint
type (str) – whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)
traffic_policy (str) – The traffic policy attached to this endpoint
description (str) – user-supplied description of the associated tunnel
metadata (str) – user-supplied metadata of the associated tunnel or edge object
bindings (Sequence[str]) – the bindings associated with this endpoint
https://ngrok.com/docs/api#api-endpoints-create
+Update an Endpoint by ID, currently available only for cloud endpoints
+id (str) – unique endpoint resource identifier
url (str) – the url of the endpoint
traffic_policy (str) – The traffic policy attached to this endpoint
description (str) – user-supplied description of the associated tunnel
metadata (str) – user-supplied metadata of the associated tunnel or edge object
bindings (Sequence[str]) – the bindings associated with this endpoint
https://ngrok.com/docs/api#api-endpoints-update
+