List Proxy Hosts
list_proxy_hostsList Nginx Proxy Manager proxy hosts with their status to find host IDs before updating, enabling, disabling, or deleting them. Filter by domain or enabled state without changing NPM.
Instructions
List proxy hosts configured in NPM, including their current status. Use this to find host IDs before get, update, enable, disable, or delete operations. It does not change NPM or request a certificate. Filter domain names by a case-insensitive substring with domain. Filter status with enabled. Set compact=True to return only summary fields. Returns a list of host objects with IDs, domains, forwarding settings, and status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Case-insensitive substring to match against any domain name; omit for all domains. | |
| compact | No | Return only summary fields when True; defaults to full NPM objects. | |
| enabled | No | Keep items with this enabled status; omit for both enabled and disabled items. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |