-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document all available API endpoints #3749
Comments
i talk about the API and wheres a good place to look for info here.. |
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. |
Checklist
jc21/nginx-proxy-manager:latest
docker image?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!
The text was updated successfully, but these errors were encountered: