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 formetadata (
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
-
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
-
list
(before_id=None, limit=None)[source]¶ List all reserved addresses on this account.
- Parameters
before_id (
Optional
[str
]) –limit (
Optional
[str
]) –
https://ngrok.com/docs/api#api-reserved-addrs-list
- Return type
-
update
(id, description=None, metadata=None)[source]¶ Update the attributes of a reserved address.
- Parameters
id (
str
) –description (
Optional
[str
]) – human-readable description of what this reserved address will be used formetadata (
Optional
[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
-