Document all available API endpoints

[kmanwar89]

Checklist

• Have you pulled and found the error with jc21/nginx-proxy-manager:latest docker image?
  • Yes
• Are you sure you're not using someone else's docker image?
  • Yes
• Have you searched for similar issues (both open and closed)?
  • Yes

Describe the bug
Several key API endpoints are not included in the OpenAPI schema; namely, deleting a proxy host, details around the required fields for programmatically creating a proxy host, etc. I've had to use browser developer tools to reverse-engineer the path to discover this endpoint (which helped tremendously in quickly deleting proxy hosts)

Nginx Proxy Manager Version
2.11.2

To Reproduce
Steps to reproduce the behavior:
There is nothing to reproduce - the behavior is that the feature is missing altogether.

Expected behavior
Expectation is for all available API endpoints to be included in the API schema document (or a Postman, or equivalent, collection provided for easy import)

Screenshots
Screenshot shows the only available schema details (as displayed in Firefox from /api/schema)

Missing from this screenshot is the /DELETE endpoint (curl --___location --request DELETE 'https://npm.mydomaincom/api//nginx/proxy-hosts/HOST_ID_NUMBER' \ --header 'Authorization: Bearer BEARER_TOKEN_VALUE_HERE)

Operating System
Docker container running on Ubuntu Server 22.04 LTS - underlying OS shouldn't play a factor here.

Additional context
Happy to expand further if above information isn't sufficient, thanks!

[gadget78]

#3195

i talk about the API and wheres a good place to look for info here..

[kmanwar89]

Thank you @gadget78 - that's helpful, and it appears we have multiple people all investigating what seems to be a common thread here - the API document is definitely in need of improvement.

I'm not a developer, just a nerd with too much time on his hands in the evenings, but I've been able to cobble together enough information to at least add/remove hosts, and that's enough for the time being. Maybe if/when v3 is finally released, the documentation will be a bit more updated. I'd love to contribute to the development if possible, but I'm not sure how I can help.

[kmanwar89]

Related issues and threads:

#1976
#3265
#3195
#3726
#1619

[github-actions]

Issue is now considered stale. If you want to keep it open, please comment 👍

[kmanwar89]

Bad bot - the issue isn't stale!

[kmanwar89]

@jc21 would appreciate any guidance you can offer on this issue please and thank you!