NginxProxyManager / NginxProxyManager/nginx-proxy-manager

GET /api/nginx/access-lists omits `clients` array without `?expand=clients` — undocumented

Open
#5,695 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
34.2k
Forks
3.9k
Avg merge
21h 12m
Merged PRs (30d)
20

Description

When fetching access lists via the API, the clients array is omitted from
the response unless you append ?expand=clients to the request.

Affected endpoints:

  • GET /api/nginx/access-lists
  • GET /api/nginx/access-lists/{id}

Expected behavior: Either clients is always included, or the API docs
state that ?expand=clients is required to retrieve them.

Actual behavior: Without ?expand=clients, the response includes an empty or
absent clients field even when clients exist. No error is returned.

Observed Impact: A script I wrote to read access lists to check idempotency
saw zero clients and attempted to recreate them on every run.

Request: Document ?expand=clients in the API reference, or include clients
by default.

Tested against v2.14.0.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin with the API reference entries for GET /api/nginx/access-lists and GET /api/nginx/access-lists/{id}, checking how the clients field and expand query parameter are described. Done means the reference clearly explains how to retrieve clients, or the chosen response behavior is documented consistently for both endpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.