Skip to content
FleetworksWarden
Menu

fleetworks / warden / api

API reference

Every operation the API serves under /api/gatehouse, grouped by area. This list is checked against the API’s route definitions on every test run.

Base path
/api/gatehouse
Auth
Bearer JWT or wl_ PAT; none for /public
Envelope
{ data, type, meta: { url, method, user_agent, request_time } }
OpenAPI
Served by the API at /openapi.json
Client
Generated TypeScript types, hooks and zod schemas (Kubb)

Areas

  • Workspaces

    List, read, create and update workspace records, and run their config Review.

    • GET /v2/workspaces
    • POST /v2/workspaces
    • GET /v2/workspaces/{workspace_name}
    • PATCH /v2/workspaces/{workspace_name}
    • GET /v2/workspaces/{workspace_name}/review

  • Current user

    The caller’s services, cloud accounts and non-onboarded services in one call.

    • GET /v2/utils/user

  • API tokens

    Issue, list, review and revoke scoped PATs for service accounts.

    • POST /v2/tokens
    • GET /v2/tokens
    • GET /v2/tokens/review
    • DELETE /v2/tokens/{id}

  • Webhooks

    Register signed HTTPS endpoints, send a test, and read delivery history.

    • POST /v2/webhooks
    • GET /v2/webhooks
    • GET /v2/webhooks/review
    • PATCH /v2/webhooks/{id}
    • DELETE /v2/webhooks/{id}
    • POST /v2/webhooks/{id}/test
    • GET /v2/webhooks/{id}/deliveries

  • VCS tenants

    Read the VCS tenant catalog mirrored from Yellow Pages, and force a sync.

    • GET /v2/vcs-tenants
    • POST /v2/vcs-tenants/sync

  • Devices

    Register and remove the push-capable devices of the signed-in user.

    • POST /v2/devices
    • DELETE /v2/devices/{id}

  • Moderation

    Content reports, the admin report queue, user blocks and EULA acceptance.

    • POST /v2/reports
    • GET /v2/reports
    • PATCH /v2/reports/{id}
    • GET /v2/blocks
    • POST /v2/blocks
    • DELETE /v2/blocks/{user_id}
    • POST /v2/eula/accept

  • Public reads

    Unauthenticated search and reads, limited to records open to everyone.

    • GET /public/search
    • GET /public/workspaces/{workspace_name}
    • GET /public/services/{yp_service_id}