npm_hosts
Manage Nginx Proxy Manager items such as proxy hosts, redirection hosts, and streams. List, create, update, delete, enable, or disable them via API.
Instructions
List, look at, add, change, delete, enable or disable NPM items.
kind: proxy-hosts, redirection-hosts, dead-hosts, streams, certificates, or access-lists. action: list, get, create, update, delete, enable, disable.
list and get are read only. list gives a short summary unless full=true.
create needs
data. Only the main fields are needed. Sensible defaults fill the rest (for proxy-hosts: http, no certificate, block_exploits on). Proxy host example: {"domain_names": ["app.example.com"], "forward_host": "172.16.1.5", "forward_port": 8080, "allow_websocket_upgrade": true}update needs
idanddatawith ONLY the fields to change. The tool reads the current item and merges, so nothing else is lost.create, update, enable and disable need confirm=true, after asking the user.
delete needs confirm=true and confirm_phrase='delete '. certificates and access-lists can only be listed, read, or deleted here. To make or change those, use npm_call. Tip: for a new outside address, use its own subdomain as a proxy host. Custom Locations under an existing domain have been unreliable on this NPM.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| data | No | ||
| full | No | ||
| kind | Yes | ||
| action | No | list | |
| confirm | No | ||
| confirm_phrase | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||