API documentation broken?
When going to https://homarr.dev/docs/management/api/ or the equivalent page in my installation, near the bottom, there is a section "Schemas" with some error messages. I was hoping to find API to create Items (creating Apps worked using the readable part of the documentation). Bug?
API | Homarr documentation
Using the Homarr API, you can interface with the application with your own code and business logic.
11 Replies
Thank you for submitting a support request.
Depending on the volume of requests, our team should get in contact with you shortly.
⚠️ Please include the following details in your post or we may reject your request without further comment: - Log (See https://homarr.dev/docs/community/faq#how-do-i-open-the-console--log) - Operating system (Unraid, TrueNAS, Ubuntu, ...) - Exact Homarr version (eg. 0.15.0, not latest) - Configuration (eg. docker-compose, screenshot or similar. Use ``your-text`` to format) - Other relevant information (eg. your devices, your browser, ...)
Frequently Asked Questions | Homarr documentation
Can I install Homarr on a Raspberry Pi?
Hi, I think this is a bug from an upstream library that we use. Probably not something we can fix. It just means that the schema is not displayed but the API should work regardless
How can I find how the API looks like?
I presume there is a POST API for items?
Without the schema you'll have to hit the API yourself and figure out
Use Postman, Hoppscotch or Bruno to do this
Or curl if you're comfortable with that
I have no problem with that, but how does that API look like? URL, expected parameters?
Also, not all actions are available in the API. We still need to add some endpoints
Should be documented. I don't understand what you're referring to?
Documented are users, invites and apps. I am looking to add items via the API.
Or does that not exist yet?
Likely doesn't exist yet. You can submit a pull request on GitHub that we add the missing endpoints. Sorry, there was an upstream bug that prevented us from fully implementing the API - so it was not our highest priority to find a fix
Fair enough. Wrote a small per script that took data exported from Heimdal to add apps in Homarr, but that still leaves me with a lot of clicks wrapping those apps into items. Anyway, thanks for your help!
You're welcome and sorry that it's not fully implemented.
If you're willing to publish that script, we'd happily add that to the document for those who need it
That script is too rough for general consumption, sorry.