Where to find TrueNAS API that is not Documented?

Hi guys, a newbie here, I am writing a python script to perform some API functions.

I find that not all API is documented. Example I am trying to use the API to trigger a sent test email but I did not find the API for it.

Do anyone knows how to find API method that is not readily available in the docs? Perhaps I would need to look into the source code? If so where would I find it?

https://api.truenas.com/v26.04/api_methods_mail.send.html
You can probably use the public mail.send method.

There is a private API, but it’s intentionally undocumented (which is typical for private APIs) and may in the future be unavailable to consumers outside of middlewared.

There is no guarantee of API stability for private APIs. They may even change during minor releases.

Ah I got it now! Thanks a lot! :raised_hands: I was on v25.04.2, and mail.send it not documented there.

I guess I will refer v26.04 now on, they are providing me with other methods that I need that is not available on v25.04.2

In 25.04 we hadn’t transitioned all public methods into our new API schema (from which the API docs are generated). So starting in 25.10 online documentation should be much cleaner.

1 Like