mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-07 03:09:44 +03:00
How do you use the API to create/update a shelf or book with a cover? #5216
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @MisterDeee on GitHub (Mar 9, 2025).
Attempted Debugging
Searched GitHub Issues
Describe the Scenario
As per the subject, I can create/update using my API wrapper or Postman just fine, everything works as expected. Except cover images. I've gone over the API docs countless times, I made sure to set the request to multipart/form-data. But every time the cover property is null in the response. It's not a user permissions issue, I am the admin and it's my token. Everything returns 200 OK so there's not even error logs to look over. What am I doing wrong?
Exact BookStack Version
v25.02
Log Content
No response
Hosting Environment
Docker container on physical host.
@ssddanbrown commented on GitHub (Mar 9, 2025):
Hi @MisterDeee,
Do you have a screenshot of the postman request? Or an example of the API wrapper you're using?
@MisterDeee commented on GitHub (Mar 9, 2025):
Yes, sorry, should have included that right away.
@ssddanbrown commented on GitHub (Mar 9, 2025):
@MisterDeee I think you may be running into a quirk of the API (and PHP in general) which is confusing matters.
Assuming the shown response is for that shown request, then no information is being updated (name not changing, so not just the cover image).
Form data requests will only work with POST requests.
To use for this PUT request, change the HTTP method used to "POST" then add a field to the sent data with name
_methodand valuePUT.If needed to reference in the future, this is mentioned in the "Request Format" part of the API docs.
I know this is really awkward right now though. I think there have been some recent PHP changes that might improve on this in the future though.
@MisterDeee commented on GitHub (Mar 9, 2025):
Wow, I should have read the docs more closely, sorry for that. But as expected, it works now! Thank you so much!
One question, is there a way to use a URL instead of uploading an actual image?
Thank you again for the excellent help!
@ssddanbrown commented on GitHub (Mar 9, 2025):
No, a file is required right now (Downloading from URLs on BookStack server-side starts to get messy when things like SSRF have to be taken into account).
Happy I could help! I'll therefore close this off.