Create Access List
create_access_listCreate an access list in Nginx Proxy Manager to define host access controls using optional IP allow/deny rules and basic-auth users.
Instructions
Create an access list containing optional IP allow/deny rules and basic-auth users. Use this to define access controls for hosts; use update_access_list to change an existing list. NPM stores the rules and credentials, while item passwords are write-only and cannot be read back. Returns the created list object with its ID, name, and rules. Set dry_run=True to preview the exact request without changing NPM.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable name for this access list. | |
| items | No | Basic-auth users as username/password pairs; passwords are write-only in NPM. | |
| clients | No | IP or network rules; each directive must be allow or deny. | |
| dry_run | No | When True, return the exact request preview without changing NPM. | |
| pass_auth | No | Whether NPM passes basic-auth credentials upstream. | |
| satisfy_any | No | Whether satisfying any configured access rule is sufficient. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||