2
0

index.rst 726 B

1234567891011121314151617181920212223242526272829
  1. Wagtail API v1
  2. ==============
  3. .. warning::
  4. This documentation covers the deprecated version 1 of the API, which is provided for backwards compatibility only. For the current version, see :doc:`/advanced_topics/api/index`
  5. The ``wagtailapi`` module can be used to create a read-only, JSON-based API for public Wagtail content.
  6. There are three endpoints to the API:
  7. * **Pages:** ``/api/v1/pages/``
  8. * **Images:** ``/api/v1/images/``
  9. * **Documents:** ``/api/v1/documents/``
  10. See :doc:`installation` and :doc:`configuration` if you're looking to add this module to your Wagtail site.
  11. See :doc:`usage` for documentation on the API.
  12. Index
  13. -----
  14. .. toctree::
  15. :maxdepth: 2
  16. installation
  17. configuration
  18. usage