Skip to main content
Version: v0.16

Admin REST API

Administrative REST API for managing Conduit.

Base URL

http://localhost:3030

Authentication

Admin Login

curl -X POST 'http://localhost:3030/login' \
-H 'masterkey: YOUR_MASTER_KEY' \
-H 'Content-Type: application/json' \
-d '{
"username": "admin",
"password": "admin"
}'

Response:

{
"token": "eyJhbGciOiJIUzI1NiIs..."
}

Request Headers

HeaderDescriptionRequired
masterkeyMaster key for admin accessYes (or token)
AuthorizationBearer token from loginYes (or masterkey)

API Documentation

Swagger UI

Access interactive documentation at:

http://localhost:3030/swagger

OpenAPI JSON

Export schema from Admin Panel > Swagger button.

Common Endpoints

Config

# Get module config
GET /config/{moduleName}

# Update module config
PUT /config/{moduleName}

Database

# List schemas
GET /database/schemas

# Create schema
POST /database/schemas

# Get schema documents
GET /database/{schemaName}

Authentication

# List users
GET /authentication/users

# Create user
POST /authentication/users

# Block user
PUT /authentication/users/{userId}/block

Example: List Schemas

curl -X GET 'http://localhost:3030/database/schemas' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'masterkey: YOUR_MASTER_KEY'

Response:

{
"schemas": [
{
"_id": "...",
"name": "Movies",
"fields": {...},
"ownerModule": "database"
}
],
"count": 1
}

Error Responses

StatusDescription
400Invalid request
401Unauthorized
403Forbidden
404Not found
500Server error