NginxProxyManager / NginxProxyManager/nginx-proxy-manager

Documentation for API?

Open
#341 16 comments 14 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hello, I see there is some kind of API at "/api" , please is there any documentation for it? I would like to incorporate nginx-proxy-manager into a development tool with automated hosts created. Thanks!

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

Start by investigating the API at /api and review the existing project structure to determine which endpoints and workflows need documentation. Done means users can find documentation explaining how to use the API for automated host creation.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.