offcial API / Nexus
-
Hello,
this is a thought I've been having, and it's just my own, but if anyone could shed some light on it, I'd really appreciate it.So, this official API / Nexus is an API we've been waiting for for years. Jaredhendrickson13 has developed a community-based one that seems to do the job just as well for both the community and pfSense+ versions. The documentation for this community API is very complete.
Coming back to our official API / Nexus, I have the impression that it's not very widely used as it is (maybe I'm wrong), and the documentation is almost non-existent apart from two or three .py examples to get you started.
For the rest, only Python developers can go through the git repository to understand how it works, find errors, and fix them, and that's not for the average person like me :-).
Is it Netgate's intention not to push this API so that more people can use it?
-
@philippe-richard You can view the documentation here (download and open the file in a web browser). Also, the pfapi-openapi.yaml contains all of the definitions as well, it's just harder to look through. I will talk to someone about getting this hosted with the rest of the pfSense documentation.
As for not being widely used, the API has only been officially released for about a month now. That's not much time for new projects. Internally, we do use the API for the new GUI.
-
@tkerr
Hello, I have a feeling the link leads to a page without documentation.
-
@philippe-richard
Download and open the file in your web browser. -
@tkerr
It is much better to download the raw file. I apologize for my ignorance.