Reserved Addresses#

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

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

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.

create(description='', metadata='', region='')[source]#

Create a new reserved address.

Parameters:

  • description (str) – human-readable description of what this reserved address will be used for

  • metadata (str) – arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

  • region (str) – reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

https://ngrok.com/docs/api#api-reserved-addrs-create

Return type:

ReservedAddr

delete(id)[source]#

Delete a reserved address.

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-reserved-addrs-delete

get(id)[source]#

Get the details of a reserved address.

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-reserved-addrs-get

Return type:

ReservedAddr

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

List all reserved addresses on this account.

Parameters:

  • before_id (str) – Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.

  • limit (str) – Constrains the number of results in the dataset. See the API Overview for details.

  • filter (str) – A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

https://ngrok.com/docs/api#api-reserved-addrs-list

Return type:

ReservedAddrList

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

Update the attributes of a reserved address.

Parameters:

  • id (str) –

  • description (str) – human-readable description of what this reserved address will be used for

  • metadata (str) – arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

https://ngrok.com/docs/api#api-reserved-addrs-update

Return type:

ReservedAddr