Reference

API reference

Every endpoint, and which need a session.

Every HTTP endpoint of the app, read from its route files. Session means the request needs a signed-in session (the deployment passcode, or the app's own sign-in); Public endpoints answer anyone.

Note

Requests that change data must come from the app's own pages; send JSON unless an endpoint says otherwise.

/api/domains

Method Path Access What it does
GET /api/domains Session —
POST /api/domains Session —
PATCH /api/domains/:id Session —
DELETE /api/domains/:id Session —
POST /api/domains/:id/check-host Session Checks that auth.<domain> answers from this service, and records the result.
POST /api/domains/:id/connect Session Connects auth.<domain> to this Worker in Cloudflare (proxied DNS record + Worker route), then checks that it answers. Safe to run again: existing pieces it created are reused.
POST /api/domains/:id/rotate-secret Session Issues a new secret key. The previous key stops working at once, and the new one is shown only now.
POST /api/domains/:id/verify Session Opens <app address>/api/auth/sign-in (https://<domain> unless the domain has an app address) without following redirects. When the Next.js integration is installed, it answers with a redirect to this service's sign-in page carrying the domain's site key.
GET /api/domains/:id/webhook Session The endpoint, its signing secret and the last 20 deliveries.
PUT /api/domains/:id/webhook Session Sets the endpoint ({ url }) or removes it ({ url: null }).
POST /api/domains/:id/webhook Session { action: "test" } sends a webhook.test event and waits for the result; { action: "rotate" } replaces the secret.

/api/edit-auth

Method Path Access What it does
GET /api/edit-auth Session —
POST /api/edit-auth Session —
DELETE /api/edit-auth Session —

/api/events

Method Path Access What it does
GET /api/events Session —
GET /api/events/daily Session Sign-ins, sign-ups and failed attempts per day, for the Activity charts.
GET /api/events/export Session The activity shown on the Activity page (same filters) as CSV, newest first.

/api/host

Method Path Access What it does
GET /api/host Public Tells the Domains page that auth.<domain> reaches this service. Public: it reveals only whether the host's domain is connected, which its sign-in page shows anyway.

/api/hosted

Method Path Access What it does
POST /api/hosted/email-code/send Public Emails a six-digit sign-in code. Answers the same way whether or not the email has an account.
POST /api/hosted/email-code/verify Public Checks an emailed code and signs the person in, creating the account on first use.
POST /api/hosted/forgot-password Public Always answers the same way, so the form does not reveal which emails have an account.
POST /api/hosted/reset-password Public —
POST /api/hosted/sign-in Public —
POST /api/hosted/sign-up Public —
POST /api/hosted/two-factor Public The two-factor step of a sign-in, by action: - verify: a 6-digit code from the authenticator app, or a recovery code; - enable: the first code from a newly scanned app, which turns two-factor on; - skip: decline the optional set-up offer.
POST /api/hosted/verify-email Public Spends a verification link. Called by the page's script, so link scanners do not use it up.

/api/items

Method Path Access What it does
GET /api/items Public Inventory endpoint read by subdomains.appneural.com. Users and activity are private, so the public inventory is the set of connected domains, without names, keys or counts.

/api/oauth

Method Path Access What it does
GET /api/oauth/:provider/callback Public Google or GitHub sends the visitor back here; on success they continue to the app with a code.
GET /api/oauth/:provider/start Public Sends the visitor from a hosted page to Google or GitHub.

/api/provision

Method Path Access What it does
GET /api/provision/nextjs Public The site key is public by design (it appears in every sign-in URL), so this needs no session. The secret key is never part of the generated files, which point the app at its own https://auth.<domain>.

/api/sessions

Method Path Access What it does
DELETE /api/sessions/:id Session Signs one device out.

/api/users

Method Path Access What it does
GET /api/users Session —
GET /api/users/:id Session The user with their sessions, linked Google and GitHub accounts, and recent activity.
PATCH /api/users/:id Session Blocks or unblocks the user (blocking also signs them out everywhere), or marks the email verified.
DELETE /api/users/:id Session —
POST /api/users/:id/reset-link Session A reset link for an admin to hand over directly, for apps without reset emails.
DELETE /api/users/:id/sessions Session Signs the user out on every device.
DELETE /api/users/:id/two-factor Session Turns two-factor off for a user who lost their phone and their recovery codes.
POST /api/users/:id/verification Session Emails the user a new verification link.
GET /api/users/export Session The users shown on the Users page (same filters) as CSV.

/api/v1

Method Path Access What it does
POST /api/v1/sessions/revoke Public The app's sign-out. Revoking a session that is already gone still succeeds.
POST /api/v1/sessions/verify Session Resolves a session token to its user; the app calls this on requests that need the user.
POST /api/v1/token Public Swaps the one-time code from the callback URL for a session token. Server-to-server only.

/api/webhook-deliveries

Method Path Access What it does
POST /api/webhook-deliveries/:id Session Sends a delivery again, once, and returns the outcome.

Other routes

Method Path Access What it does
GET /health Public Liveness and database check. The System Registry lists https://<host>/health for every catalog.

Pages in the app

Page What it shows
/ auth.appneurox.com: every domain with authentication, and setting up a new one.
/activity —
/email-code —
/forgot-password —
/reset-password —
/setup —
/sign-in —
/sign-up —
/two-factor —
/users —
/verify-email —
Last updated 2 November 2026