Reserved Domains

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

class ngrok.services.ReservedDomainsClient(client)

create(name, region='', description='', metadata='', http_endpoint_configuration_id='', https_endpoint_configuration_id='', certificate_id=None, certificate_management_policy=None)

Create a new reserved domain.

Parameters

• name (str) – the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a ‘.’ it will reserve that subdomain on ngrok.io.

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

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

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

• http_endpoint_configuration_id (str) – ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain

• https_endpoint_configuration_id (str) – ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain

• certificate_id (Optional[str]) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.

• certificate_management_policy (Optional[ReservedDomainCertPolicy]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.

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

Return type

ReservedDomain

delete(id)

Delete a reserved domain.

Parameters

id (str) – a resource identifier

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

delete_certificate(id)

Detach the certificate attached to a reserved domain.

Parameters

id (str) – a resource identifier

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

delete_certificate_management_policy(id)

Detach the certificate management policy attached to a reserved domain.

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy

delete_http_endpoint_config(id)

Detach the http endpoint configuration attached to a reserved domain.

Parameters

id (str) – a resource identifier

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

delete_https_endpoint_config(id)

Detach the https endpoint configuration attached to a reserved domain.

Parameters

id (str) – a resource identifier

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

get(id)

Get the details of a reserved domain.

Parameters

id (str) – a resource identifier

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

Return type

ReservedDomain

list(before_id=None, limit=None)

List all reserved domains on this account.

Parameters

• before_id (Optional[str]) –

• limit (Optional[str]) –

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

Return type

ReservedDomainList

update(id, description=None, metadata=None, http_endpoint_configuration_id=None, https_endpoint_configuration_id=None, certificate_id=None, certificate_management_policy=None)

Update the attributes of a reserved domain.

Parameters

• id (str) –

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

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

• http_endpoint_configuration_id (Optional[str]) – ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain

• https_endpoint_configuration_id (Optional[str]) – ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain

• certificate_id (Optional[str]) – ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.

• certificate_management_policy (Optional[ReservedDomainCertPolicy]) – configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.

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

Return type

ReservedDomain