Database

The @database endpoint exposes system information about the database.

Send a GET request to the @database endpoint:

GET /@database 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 login = await cli.login({ username: 'admin', password: 'admin' });

const { data } = await cli.getDatabase({
  token: login.data.token,
});

The response will contain the database information:

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

{
  "@id": "http://localhost:8080/@database",
  "db_name": "nick",
  "db_size": "10 MB",
  "pool": {
    "min": 2,
    "max": 10
  },
  "blob_size": "10 MB"
}