API Endpoints

Default nameservice prefix is /api/guardian
List Of Configurations Endpoints
Endpoints
Description
Type
​/configurations​
Returns configurations for Guardian plugins
GET
List Of Groups Endpoints
Endpoints
Description
Type
​/groups​
Returns all Groups
GET
​/groups/:name​
Returns Group by its name
GET
​/groups/:name/users​
Returns Users of a Group by name
GET
List Of Users Endpoints
Endpoints
Description
Type
​/users​
Returns all Users
GET
​/users/:id​
Returns User by Publickey
GET
​/users/:id/groups​
Returns All Groups of User by Publickey
GET
​
Guardian Client
A Light Typescript Client Supporting Guardian REST API
Installation
​yarn​
1
yarn add @protokol/client
Copied!
​pnpm​
1
pnpm add @protokol/client
Copied!
​npm​
1
npm install @protokol/client
Copied!
Initialization
1
import { ProtokolConnection } from "@protokol/client";
2
​
3
const connection = new ProtokolConnection("https://explorer.protokol.sh/api");
Copied!
​
​
​