Agent Ingresses#

Do not construct this object directly, instead access the agent_ingresses property of an ngrok.Client object.

class ngrok.services.AgentIngressesClient(client)[source]#

create(domain, description='', metadata='', certificate_management_policy=None)[source]#

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.

Parameters:

description (str) – human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadata (str) – arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
domain (str) – the domain that you own to be used as the base domain name to generate regional agent ingress domains.
certificate_management_policy (AgentIngressCertPolicy) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.

delete(id)[source]#

Delete an Agent Ingress by ID

Get the details of an Agent Ingress by ID.

list(before_id=None, limit=None)[source]#

List all Agent Ingresses owned by this account

Parameters:

update(id, description=None, metadata=None, certificate_management_policy=None)[source]#

Update attributes of an Agent Ingress by ID.

Parameters:

id (str) –
description (str) – human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadata (str) – arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
certificate_management_policy (AgentIngressCertPolicy) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.