API Reference

wagtail-unveil exposes a versioned JSON API for querying discovered URLs programmatically.

In This Section

• Endpoints — Authentication, endpoint URLs, filters, and response shape

Quick Reference

# Backend (admin) URLs
curl -H "Authorization: Bearer your-key" http://localhost:8000/unveil/api/v1/backend-urls/

# Frontend URLs
curl -H "Authorization: Bearer your-key" http://localhost:8000/unveil/api/v1/frontend-urls/

# Platform runtime and dependency inventory
curl -H "Authorization: Bearer your-key" http://localhost:8000/unveil/api/v1/platform/

Related

• Getting Started — Set up the API key
• Configuration — API key settings
• Features — HTML report counterparts, including the platform report
• Documentation Index — Back to overview