Skip to content

Lawwwing Audit API Documentation

Welcome to the documentation for the Lawwwing Audit service.

This project exposes an API to create and retrieve audit jobs for website analysis.

Public API Scope

The only public, externally accessible endpoints are the Audit Jobs endpoints:

  • POST /api/v1/jobs/ to create an audit job
  • GET /api/v1/jobs/{job_id}/ to fetch one audit job

Endpoints related to diagnostics, image scan, or internal workflows are not public API.

Authentication

Public API requests require token authentication:

  • Header: Authorization: Token <your_token>

Quick Start

1. Create a Job

curl -X POST https://audit.lawwwing.com/api/v1/jobs/ \
  -H "Authorization: Token <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "site.com",
  }'

3. Get Job Details

curl https://audit.lawwwing.com/api/v1/jobs/<JOB_UUID>/ \
  -H "Authorization: Token <TOKEN>"

Full Reference

See API reference for full request/response details.