[GH-ISSUE #1808] API Documentation #1338

Closed
opened 2026-02-26 07:30:33 +03:00 by kerem · 4 comments
Owner

Originally created by @debritde on GitHub (Jan 26, 2022).
Original GitHub issue: https://github.com/NginxProxyManager/nginx-proxy-manager/issues/1808

Hello,
is there an API Documentation and when not is there a possibility to add one?

Originally created by @debritde on GitHub (Jan 26, 2022). Original GitHub issue: https://github.com/NginxProxyManager/nginx-proxy-manager/issues/1808 Hello, is there an API Documentation and when not is there a possibility to add one?
kerem 2026-02-26 07:30:33 +03:00
Author
Owner

@Techout592 commented on GitHub (Jan 29, 2022):

There is no API documentation, I've tried testing around as well but couldn't find anything. I opened an issue as well regarding this at https://github.com/NginxProxyManager/nginx-proxy-manager/issues/1790.

<!-- gh-comment-id:1024762555 --> @Techout592 commented on GitHub (Jan 29, 2022): There is no API documentation, I've tried testing around as well but couldn't find anything. I opened an issue as well regarding this at https://github.com/NginxProxyManager/nginx-proxy-manager/issues/1790.
Author
Owner

@ridvanaltun commented on GitHub (Feb 9, 2022):

Actually, under the backend/doc folder, there is a Swagger file but looks old (last updated 2 years ago).

Also you can find the Swagger scheme from this url: npm-admin-ui:81/api/schema

You can copy-paste the scheme to https://editor.swagger.io/ and you can generate API documentation.

<!-- gh-comment-id:1034249230 --> @ridvanaltun commented on GitHub (Feb 9, 2022): Actually, under the `backend/doc` folder, there is a Swagger file but looks old (last updated 2 years ago). Also you can find the Swagger scheme from this url: `npm-admin-ui:81/api/schema` You can copy-paste the scheme to https://editor.swagger.io/ and you can generate API documentation.
Author
Owner

@github-actions[bot] commented on GitHub (Feb 25, 2024):

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

<!-- gh-comment-id:1962784577 --> @github-actions[bot] commented on GitHub (Feb 25, 2024): Issue is now considered stale. If you want to keep it open, please comment :+1:
Author
Owner

@github-actions[bot] commented on GitHub (Apr 10, 2025):

Issue was closed due to inactivity.

<!-- gh-comment-id:2791370827 --> @github-actions[bot] commented on GitHub (Apr 10, 2025): Issue was closed due to inactivity.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/nginx-proxy-manager-NginxProxyManager#1338
No description provided.