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='')[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.

https://ngrok.com/docs/api#api-agent-ingresses-create

Return type

AgentIngress

delete(id)[source]

Delete an Agent Ingress by ID

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-agent-ingresses-delete

get(id)[source]

Get the details of an Agent Ingress by ID.

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-agent-ingresses-get

Return type

AgentIngress

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

List all Agent Ingresses owned by this account

Parameters
  • before_id (Optional[str]) –

  • limit (Optional[str]) –

https://ngrok.com/docs/api#api-agent-ingresses-list

Return type

AgentIngressList

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

Update attributes of an Agent Ingress by ID.

Parameters
  • id (str) –

  • description (Optional[str]) – human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

  • metadata (Optional[str]) – arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

https://ngrok.com/docs/api#api-agent-ingresses-update

Return type

AgentIngress