API Feature #661

New Issue

OVERLORD · 2026-02-04T21:42:44+03:00

OVERLORD commented

2026-02-04 21:42:44 +03:00

Originally created by @examinare-dk on GitHub (May 3, 2018).

Hello, this is more of a question to get involved in the project but only if there is a need for the functionality.

I have looked at the codebase but this is the first time I ever develop with this framework but have been a PHP developer commercially for over 17 years.

My request is: If you are willing to get an API done where I can make the Api functions live in the project I would willing to devote some time for this. The functions I would like to add initially:

Enable the possibility to fetch content to external systems. (For knowledge base sites or external sites)
Add users enabled to login from external sites.

Then from there it would in theory possiblity to add an external sites connector for example you could make a main site on domain1.blah.com and have a small portion on a domain2.blah.com but that will use only a small part of the system in form of using the API for this.

Technology:

Api should be a simple JSON or XML connection so that you can embed things into it and use for external sites etc.

What I need to be enabled to start this:

Would need some help to get started mainly to have a slug connected to my function or class for instance /api/ to a special external class and also, of course, a connection to someone who I can ask things about the project to get the work done.

Originally created by @examinare-dk on GitHub (May 3, 2018). Hello, this is more of a question to get involved in the project but only if there is a need for the functionality. I have looked at the codebase but this is the first time I ever develop with this framework but have been a PHP developer commercially for over 17 years. My request is: If you are willing to get an API done where I can make the Api functions live in the project I would willing to devote some time for this. The functions I would like to add initially: - Enable the possibility to fetch content to external systems. (For knowledge base sites or external sites) - Add users enabled to login from external sites. Then from there it would in theory possiblity to add an external sites connector for example you could make a main site on domain1.blah.com and have a small portion on a domain2.blah.com but that will use only a small part of the system in form of using the API for this. Technology: Api should be a simple JSON or XML connection so that you can embed things into it and use for external sites etc. What I need to be enabled to start this: - Would need some help to get started mainly to have a slug connected to my function or class for instance /api/ to a special external class and also, of course, a connection to someone who I can ask things about the project to get the work done.

OVERLORD added the 🛠️ Enhancement label 2026-02-04 21:42:44 +03:00

OVERLORD closed this issue

2026-02-04 21:42:50 +03:00

OVERLORD commented

2026-02-04 21:42:59 +03:00

@jakoubek commented on GitHub (Jun 5, 2018):

Yes - an API would be really useful. I have a ton of documentation that I would like to import into a Bookstack instance (without having to write SQL import statements).

@jakoubek commented on GitHub (Jun 5, 2018): Yes - an API would be really useful. I have a ton of documentation that I would like to import into a Bookstack instance (without having to write SQL import statements).

OVERLORD commented

2026-02-04 21:43:19 +03:00

@tiredofit commented on GitHub (Aug 22, 2018):

An API would be very useful for exact usage case above, yet also an opportunity to display "Books" available to the user in question linking them to either BookStackApp, or displaying the actual content.
The ability to add a book/create a book and place in an Upcoming "Shelf" feature would be very useful as well!

@tiredofit commented on GitHub (Aug 22, 2018): An API would be very useful for exact usage case above, yet also an opportunity to display "Books" available to the user in question linking them to either BookStackApp, or displaying the actual content. The ability to add a book/create a book and place in an Upcoming "Shelf" feature would be very useful as well!

OVERLORD commented

2026-02-04 21:43:21 +03:00

@alpunch commented on GitHub (Nov 13, 2018):

Hi guys. An API feature for book management would be really useful : adding a job to my CI to push .md doc to BookStack would be neat (;

@alpunch commented on GitHub (Nov 13, 2018): Hi guys. An API feature for book management would be really useful : adding a job to my CI to push .md doc to BookStack would be neat (;

OVERLORD commented

2026-02-04 21:43:24 +03:00

@samtuke commented on GitHub (May 6, 2019):

+1. We need to import xhtml. Cli import would also be fine.

@samtuke commented on GitHub (May 6, 2019): +1. We need to import xhtml. Cli import would also be fine.

OVERLORD commented

2026-02-04 21:43:33 +03:00

@ssddanbrown commented on GitHub (May 6, 2019):

Just to confirm, An API implementation is upcoming on the roadmap. I have opened issue #1414 to discuss authentication options.

@ssddanbrown commented on GitHub (May 6, 2019): Just to confirm, An API implementation is upcoming on the [roadmap](https://github.com/BookStackApp/BookStack#road-map). I have opened issue #1414 to discuss authentication options.

OVERLORD commented

2026-02-04 21:43:42 +03:00

@col-panic commented on GitHub (Oct 2, 2019):

I want to add a healthcheck to my bookstack container. Here I would really like to have an API endpoint which tells me whether bookstack is up and running ok.

For rocketchat, for example, this looks like this (as part of the docker-compose.yml)

    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3000/chat/api/info"]
      interval: 30s
      timeout: 5s
      retries: 3

@col-panic commented on GitHub (Oct 2, 2019): I want to add a healthcheck to my bookstack container. Here I would really like to have an API endpoint which tells me whether bookstack is up and running ok. For rocketchat, for example, this looks like this (as part of the docker-compose.yml) ``` healthcheck: test: ["CMD", "curl", "-f", "http://localhost:3000/chat/api/info"] interval: 30s timeout: 5s retries: 3 ```

OVERLORD commented

2026-02-04 21:43:48 +03:00

@MarcusTheSmith commented on GitHub (Nov 5, 2019):

Glad this is on the road-map! Is there a timeline for this?

@MarcusTheSmith commented on GitHub (Nov 5, 2019): Glad this is on the road-map! Is there a timeline for this?

OVERLORD commented

2026-02-04 21:43:53 +03:00

@ssddanbrown commented on GitHub (Nov 16, 2019):

@MarcusTheSmith Nothing strict, since this project is only really a free-time endeavour, but the plan is to have an initial auth implementation with a single set of endpoints in the next release to gain feedback on. Hoping to have next release done for end of year at latest. Then expand on API in future release to cover other endpoints. So maybe first quarter of next year is what I'd like.

@ssddanbrown commented on GitHub (Nov 16, 2019): @MarcusTheSmith Nothing strict, since this project is only really a free-time endeavour, but the plan is to have an initial auth implementation with a single set of endpoints in the next release to gain feedback on. Hoping to have next release done for end of year at latest. Then expand on API in future release to cover other endpoints. So maybe first quarter of next year is what I'd like.

OVERLORD commented

2026-02-04 21:43:56 +03:00

@cipi1965 commented on GitHub (Jan 1, 2020):

I’m currently implementing a GraphQL endpoint in BookStack. I don’t know if anyone is interested

@cipi1965 commented on GitHub (Jan 1, 2020): I’m currently implementing a GraphQL endpoint in BookStack. I don’t know if anyone is interested

OVERLORD commented

2026-02-04 21:44:04 +03:00

@modem7 commented on GitHub (Jan 9, 2021):

Definitely interested in the endpoint for docker!

@modem7 commented on GitHub (Jan 9, 2021): Definitely interested in the endpoint for docker!

OVERLORD commented

2026-02-04 21:44:13 +03:00

@ssddanbrown commented on GitHub (Jan 9, 2021):

As of v0.31 we now have core CRUD actions for shelves, books, chapters and pages: https://www.bookstackapp.com/blog/beta-release-v0-31-0/#api-update---pages

Additionally, I have setup a repo to house some API script examples that can be used as a base or for reference:
https://github.com/BookStackApp/api-scripts

Therefore I'm going to close this off but feel free to open new issues if you have a legitimate need for additional specific endpoints or features.

@ssddanbrown commented on GitHub (Jan 9, 2021): As of v0.31 we now have core CRUD actions for shelves, books, chapters and pages: https://www.bookstackapp.com/blog/beta-release-v0-31-0/#api-update---pages Additionally, I have setup a repo to house some API script examples that can be used as a base or for reference: https://github.com/BookStackApp/api-scripts Therefore I'm going to close this off but feel free to open new issues if you have a legitimate need for additional specific endpoints or features.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#661