wallvon/mofh-api-docs

API Documentation for https://myownfreehost.net

👋 I'm Robert S.

A full-stack developer and tech enthusiast from the Netherlands.

Check out my website https://robert-s.dev for my recent work.

Languages

Frameworks & Libraries

Miscellaneous

Currently learning

You can contact me on Discord robe.rt or by emailing me here

mofh-api-docs's Issues

getcname.php

Validate domain by CNAME

This endpoint allows you to add a domain using CNAME validation instead of DNS validation. It uses a POST request, which is confusing because it's called getcname but whatever.

Right now it is not possible to create an account with an domain that has been verified by CNAME via the API! Its only possible to manually add that in vPanel.
- BastelPichi

Required parameters:

• api_user
• api_key
  - username
• domain_name

XML API:

https://panel.myownfreehost.net/xml-api/getcname.php

Example response:

73081144a0525fde6ba1b0510684efcf

JSON API:

https://panel.myownfreehost.net/json-api/getcname.php

Example response:

73081144a0525fde6ba1b0510684efcf

---

Thanks to @BastelPichi for bringing up the missing endpoint.

Where can I find the callback url?

Hello. I was trying to set the API with WHMCS. When I click the "Refresh" button of the MOFH server on the "Servers" page, the WHMCS returned this error tip:

Error
Not Found
The requested URL /json-api/batch.php was not found on this server.

So I dived into the API Documents and see if I missed something. Then I was confused with the Callback URL. How can I find it? Should I create a callback file and put them into my WHMCS folder first? Also, what is the absolute path of "/json-api/batch.php"? Should it be the "http://panel.myownfreehost.net/" or my WHMCS domain?

Thank you.

Add link to related callbacks on request pages

See title. This would, for example, add a link to the ticket response callback page on the create ticket page.

listpkgs.php

Return current user's available hosting plans

According to cPanel's documentation, the listpkgs endpoint does the following: "This function lists the authenticated user's available hosting plans (packages)."

XML API:

https://panel.myownfreehost.net/xml-api/listpkgs.php
TODO. However, according to people in the iFastNet Community Discord server, the XML API endpoint is broken.

JSON API:

https://panel.myownfreehost.net/json-api/listpkgs.php

Call with no plans:

{"package":[{"FRONTPAGE":"n","CPMOD":"x3","FEATURELIST":"default","BWLIMIT":9223372036854775807,"IP":"n","CGI":"n","MAXSUB":9999,"name":"Default","MAXSQL":999,"MAXFTP":"1","QUOTA":9223372036854775807,"MAXPARK":9999,"HASSHELL":"N","MAXADDON":9999,"MAXPOP":"10","MAXLIST":"0","LANG":"english"}]}

Call with a "Test" plan:

{"package":[{"FRONTPAGE":"n","CPMOD":"x3","FEATURELIST":"default","BWLIMIT":9223372036854775807,"IP":"n","CGI":"n","MAXSUB":9999,"name":"Default","MAXSQL":999,"MAXFTP":"1","QUOTA":9223372036854775807,"MAXPARK":9999,"HASSHELL":"N","MAXADDON":9999,"MAXPOP":"10","MAXLIST":"0","LANG":"english"},{"FRONTPAGE":"n","CPMOD":"x3","FEATURELIST":"default","BWLIMIT":"9223372036854775807","IP":"n","CGI":"n","MAXSUB":"9999","name":"Test","MAXSQL":"999","MAXFTP":"1","QUOTA":"9223372036854775807","MAXPARK":"9999","HASSHELL":"n","MAXADDON":"9999","MAXPOP":"10","MAXLIST":"0","LANG":"english"},{"FRONTPAGE":"n","CPMOD":"x3","FEATURELIST":"default","BWLIMIT":"9223372036854775807","IP":"n","CGI":"n","MAXSUB":"9999","name":"lve0A9SRQo1Cr7HwuqH96DngzvLxn36TYrPB9MpBiuZWE0wtplpv2ecb6lRjRWfvS2iqRMArzWMlh7czbO6YPyJucyxjSEYHC7ZPvn08hsY3ZiE1RSDvxXER1NTprFoAbgT6ZHGvqZYFFvudliUhHp4f3iZGqef6tWVNRhB2D04AwtrDP2zeocoIduHOIuPabEV332vaAdz5Guo4eSAfTlnPBlunXgIkz9XAQK7SLXE0Qrsj2sH5rJOQe8MY3MX_Test","MAXSQL":"999","MAXFTP":"1","QUOTA":"9223372036854775807","MAXPARK":"9999","HASSHELL":"n","MAXADDON":"9999","MAXPOP":"10","MAXLIST":"0","LANG":"english"}]}

---

Thanks to @4yx for providing the JSON API responses and for bringing up the missing endpoint.

Missing documentation about API callbacks

When reading the documentation, I noticed there's no mention of API callbacks.
Would be nice if the API callbacks are documented here as well.

Remove/edit "account suspension" from ticket system callbacks section

Currently, there is a section with "account suspension" in the ticket system section of the callbacks page:

This seems to have happened in the callback update, #22, and I don't know what it is supposed to say there. Does anyone have an idea?

CC: @greenreader9

Redo with Nextra

Redo the docs with Docusaurus, it looks nicer in my opinion. I was already done with this, and I added git and set the origin to this repository, but then I accidentally reset my local environment which removed all Docusaurus files and replaced them with the files from this repo.

Images are not being displayed properly

This is because binary files are being incorrectly handled, see anorcle/next-pages#4

However, I did try this fork but that did not seem to help. I will look into this later.