Cloudron makes it easy to run web apps like WordPress, Nextcloud, GitLab on your server. Find out more or install now.


I would like the opportunity to edit the rest of the API documentation


  • When I first joined the forum, literally in @nebulon's first post to me, he said:

    Regarding the CLI tool and the API, this discrepancy is only there since we haven't yet documented that whole API. But the cli as well as the actual dashboard are fully built on top of the REST API. So far the usage of the API directly simply wasn't asked for a lot, thus the lack of wholesome docs 😕

    And I was wondering who moderates documentation (likely currently @girish and / or @nebulon) and if I could be given the chance to fill in the documentation gaps. I had to RE a lot of things (including undocumented API calls) to get to where I'm at today and I want the next developer to fly past the steps I had to dive deep into to find. I'll start with the API documentation, but eventually just the regular documentation pages (especially the Custom Cloudron App Development page) could use some more information and this is the perfect outlet instead of me being overbearing in the forums a bit. 😅

  • Staff

    Yes, please. https://git.cloudron.io/cloudron/docs/-/blob/master/cloudron_api_swagger.yaml . Just send us any PRs . There is no such thing as undocumented API in cloudron, so feel free to document anything and everything.


  • @girish said in I would like the opportunity to edit the rest of the API documentation:

    Yes, please. https://git.cloudron.io/cloudron/docs/-/blob/master/cloudron_api_swagger.yaml . Just send us any PRs . There is no such thing as undocumented API in cloudron, so feel free to document anything and everything.

    I'm glad you said that because I was nervous about at least one endpoint debug_mode, but what do you think? Should I still document that one or leave it alone?

  • Staff

    @Lonk said in I would like the opportunity to edit the rest of the API documentation:

    I'm glad you said that because I was nervous about at least one endpoint debug_mode, but what do you think? Should I still document that one or leave it alone?

    All the APIs are in use somewhere 🙂 Nothing is superfluous. debug_mode, repair everything is in use in the UI and also the CLI tool. You can grep the dashboard and CLI code for it.


  • @girish said in I would like the opportunity to edit the rest of the API documentation:

    All the APIs are in use somewhere 🙂 Nothing is superfluous. debug_mode, repair everything is in use in the UI and also the CLI tool. You can grep the dashboard and CLI code for it.

    I've heard about grep my whole development life, but would you believe I don't really know that that is? I know you put in the terminal with...maybe a file or folder and give some kind of expression and it gives you data.

    Soooo, I assume your suggestion would be to learn the grep CLI command's syntax and then use it to search all the files / folders in box (which I have full access to know thanks to you ☺️) to help with the API documentation? Which means I just need to figure out the right expression right? Do all of your endpoints share a pattern in the code? Is that what you meant I should try to do?


  • @girish Alright, I'll add debug_mode but it's a pretty dang powerful endpoint.

    Also, it says on Gitlab that I have to make a branch to do a "merge request", but I didn't have access to that so I forked it and added one new endpoint as you can see here:

    https://git.cloudron.io/lonk/docs/-/commit/729198a2c56304d2ef1074b0e6a9dab76de5a29a

    But I see no way for me to ask the main repo to merge request with it. Was I supposed to be able to make a branch like the Gitlab says on how to do a Merge Request (https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)?


  • @girish I started getting Gitlab build errors in the docs fork I made from something called pipelines (likely how you guys deploy). So I def contributed to this incorrectly. I'll just edit it locally until I'm able to merge request the API docs properly (can't wait to get to the File Manager API, haven't RE-ed that one yet).

    I also hope there's some secret API calls that you don't even use in Dashboard or Cloudron CLI. I love hidden API endpoints like that. It's like getting to see the beginning of an abandoned (or yet to be implemented) idea.