System

The @system endpoint exposes system information about the Nick backend.

Send a GET request to the @system endpoint:

GET /@system HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJhZG1pbiIsImZ1bGxuYW1lIjoiQWRtaW4iLCJpYXQiOjE2NDkzMTI0NDl9.RS1Ny_r0v7vIylFfK6q0JVJrkiDuTOh9iG9IL8xbzAk

Or use the client directly:

import { Client } from '@robgietema/nick';

const cli = Client.initialize({ apiPath: 'http://localhost:8080' });

const { data } = await cli.getSystem();

The response will contain the system information:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@id": "http://localhost:8080/@system",
   "items": [
    {
      "label": "Nick",
      "value": "2.8.0"
    },
    {
      "label": "Node.js",
      "value": "v26.2.0"
    },
    {
      "label": "Express",
      "value": "5.2.1"
    },
    {
      "label": "Objection.js",
      "value": "3.1.5"
    },
    {
      "label": "Knex",
      "value": "3.2.10"
    },
    {
      "label": "PostgreSQL",
      "value": "18.3"
    }
  ]
}