Admin API

The api package provides a Forge-style RESTful HTTP API for managing all Dispatch entities. Routes are prefixed at /v1 by default.

Setup01

import "github.com/xraph/dispatch/api"

mux := http.NewServeMux()
api.RegisterRoutes(mux, eng)

log.Fatal(http.ListenAndServe(":8080", mux))

When using the Forge extension, routes are registered automatically under the configured BasePath (default: /api/dispatch).

Routes02

Jobs

Workflows

Crons

DLQ

Stats

Error responses03

All errors return JSON:

{"error": "job not found"}