Reserved Addresses

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

class ngrok.services.ReservedAddrsClient(client)

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='', endpoint_configuration_id=None)

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)

• endpoint_configuration_id (Optional[str]) – ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address

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

Return type

ReservedAddr

delete(id)

Delete a reserved address.

Parameters

id (str) – a resource identifier

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

delete_endpoint_config(id)

Detach the endpoint configuration attached to a reserved address.

Parameters

id (str) – a resource identifier

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

get(id)

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)

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

ReservedAddrList

update(id, description=None, metadata=None, endpoint_configuration_id=None)

Update the attributes of a reserved address.

Parameters

• id (str) –

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

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

• endpoint_configuration_id (Optional[str]) – ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address

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

Return type

ReservedAddr