Protokol
Search…
⌃K

API Endpoints

List of Guardian API Endpoints
Default nameservice prefix is /api/guardian

List Of Configurations Endpoints

Endpoints
Description
Type
Returns configurations for Guardian plugins
GET

List Of Groups Endpoints

Endpoints
Description
Type
/groups
Returns all Groups
GET
Returns Group by its name
GET
Returns Users of a Group by name
GET

List Of Users Endpoints

Endpoints
Description
Type
/users
Returns all Users
GET
Returns User by Publickey
GET
Returns All Groups of User by Publickey
GET

Guardian Client

A Light Typescript Client Supporting Guardian REST API

Installation

yarn

yarn add @protokol/client

pnpm

pnpm add @protokol/client

npm

npm install @protokol/client

Initialization

import { ProtokolConnection } from "@protokol/client";
const connection = new ProtokolConnection("https://explorer.protokol.sh/api");