API reference

Healthcheck

Before you begin

This page uses Nexus's generated request and response schema. Requests still require the correct account, workspace, and resource permissions.

GET/health

Workspace

curl --request GET 'https://school.narb.cc/api/health' \
  --header 'Authorization: Bearer YOUR_TOKEN'

This builds a request example. Fill in required query values, then replace path placeholders and YOUR_TOKEN in your own environment. Use a token for a user with access to this workspace. Responses and permissions depend on your account and deployment. Never paste a private token into documentation.

Download the Nexus OpenAPI schema ↗
Import the schema into your API client. It describes the backend source; enabled routes depend on your workspace.

Authentication and scope#

Send requests to the workspace that owns the resource. Authentication does not by itself grant a school membership, class assignment, or administrator permission. School endpoints apply their role and class checks on the server.

Use a credential issued for that workspace with only the permissions your integration needs. Keep it on your server. Do not place credentials in a public website or a shared skill.

Liveness probe. Answers only "is this process still running".

Deliberately checks nothing else. Liveness failures restart the container, and saturation is load-induced and correlated across replicas, so gating restarts on it would turn a slowdown into an outage. Use /health/ready for that.

Responses#

200#

Successful Response

{
  "properties": {
    "success": {
      "type": "boolean",
      "title": "Success"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Message"
    },
    "data": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ],
      "title": "Data"
    }
  },
  "type": "object",
  "required": [
    "success"
  ],
  "title": "StatusResponse"
}

Access and error handling#

A signed-out or expired session needs authentication. A denied request can mean the account lacks permission, class membership, an approved model, or an available allowance. Do not retry a write blindly after a network failure; first check whether it was recorded.

Treat validation errors as a request problem. Use the returned field details to correct the request. Resource identifiers do not confer access.

Schema version#

Generated from Nexus backend source fe1c3a07c793029d3d87191a68f89e481afd6bc8. Check your deployed version before integrating. Schema coverage is not a live acceptance test.