HTTP API

Endpoints below are based on known Oxy Controller functionality. Each route is only available if the current installation exposes it. Example JSON is illustrative. Never put real tokens in frontend code.

cURL · health
curl -sS https://oxcontroller.app/v1/health
JavaScript · health
const res = await fetch("https://oxcontroller.app/v1/health");
const data = await res.json();

GET /v1/health

Health

Liveness check for the Oxy Controller HTTP service. Use this from uptime monitors. Availability depends on the current installation.

Authentication
Typically unauthenticated. Confirm against your installation.
Availability
Depends on the current installation.

Errors

  • 503 — Service unavailable.
  • 500 — Internal error.
Example response
{
  "ok": true,
  "service": "oxy-controller"
}
  • Example body is illustrative. Field names may differ in your installation.
  • This is Oxy’s own health route, not the Oxford Response API.

GET /v1/status

Status

Aggregated service status for the bot, API, and related components. Use only if your installation exposes it — this documentation site does not pretend to live-probe production.

Authentication
Typically unauthenticated. Confirm against your installation.
Availability
Depends on the current installation.

Errors

  • 404 — Route not enabled on this installation.
  • 503 — Status backend unavailable.
Example response
{
  "ok": true,
  "services": [
    { "id": "bot", "state": "operational" },
    { "id": "api", "state": "operational" }
  ]
}

GET /v1/bot/info

Bot information

Public metadata about the running bot process, such as version and identity fields your installation chooses to expose.

Authentication
May require operator authentication. Never send a real token from frontend JavaScript.
Availability
Depends on the current installation.

Errors

  • 401 — Authentication required or invalid.
  • 404 — Route not enabled.
Example response
{
  "ok": true,
  "version": "5.0.0",
  "name": "Oxy Controller"
}

GET /v1/bot/shards

Shards

Shard list and connectivity snapshot for the Discord gateway. Useful for operators diagnosing disconnects.

Authentication
May require operator authentication.
Availability
Depends on the current installation.

Errors

  • 401 — Authentication required or invalid.
  • 404 — Route not enabled.
Example response
{
  "ok": true,
  "shards": [
    { "id": 0, "status": "ready" }
  ]
}

GET /v1/website/features

Website features

Feature catalogue consumed by the public website. Safe to cache. Does not include secrets.

Authentication
Typically unauthenticated.
Availability
Depends on the current installation.

Errors

  • 404 — Route not enabled.
Example response
{
  "ok": true,
  "features": [
    { "slug": "moderation", "name": "Moderation" }
  ]
}

GET /v1/website/templates

Website templates

Public template index for the template platform. Private templates must not appear here unless the caller is authorised.

Authentication
Public list is typically unauthenticated. Private templates require authorised access according to the implementation.
Availability
Depends on the current installation.

Errors

  • 404 — Route not enabled.
Example response
{
  "ok": true,
  "templates": [
    { "slug": "example-layout", "visibility": "public" }
  ]
}

GET /v1/website/templates/:slug

Website template by slug

Metadata for a single template. Private templates should only resolve for the owner or other authorised users.

Authentication
Public templates typically unauthenticated. Private templates require authorised access.
Availability
Depends on the current installation.

Errors

  • 404 — Unknown slug, or a private template the caller cannot read.
  • 403 — Authenticated but not allowed to read this template.
Example response
{
  "ok": true,
  "template": {
    "slug": "example-layout",
    "name": "Example layout",
    "visibility": "public"
  }
}