Docs/Zurvan/API Overview

Zurvan REST API & Gateway Overview

The VynTech Zurvan API follows the modular standalone microservice pattern established across VynTech ID and VynTech Account, while fully supporting centralized deployment behind the VynTech Unified API Gateway.

VynTech Cloud API Base: https://zurvan.apis.vyntech.com.au/api/v1  •  Self-Hosted Default: http://localhost:8080/api/v1
All authenticated endpoints require a valid JWT token in the Authorization: Bearer <token> header.

Dual Architecture Model

┌────────────────────────────────────────────────────────┐
│                   VynTech Ecosystem                    │
└──────────────────────────┬─────────────────────────────┘
                           │
       ┌───────────────────┴───────────────────┐
       ▼                                       ▼
┌──────────────────────────────┐   ┌──────────────────────────────┐
│   Decoupled / Standalone     │   │   Unified Platform Gateway   │
│       Microservice           │   │  (zurvan.apis.vyntech.com.au)│
│                              │   │                              │
│ • Independent Go REST API    │   │ • Central API Gateway        │
│ • Local SQLite / Postgres    │   │ • VynTech ID & SSO Sync      │
│ • Embedded Scalar & Swagger  │   │ • Unified Billing & Access   │
│ • Custom Ports & DB URLs     │   │ • Multi-App Synergy          │
└──────────────────────────────┘   └──────────────────────────────┘

Health & Diagnostics Probes


Service Health & Uptime

Returns service health, version, database engine type, and system uptime.

Status Codes

  • Name
    200
    Type
    HTTP
    Description
    Service is operational.
Request
GET/api/v1/health
Response 200

Readiness Probe with DB Check

Kubernetes readiness probe verifying active database connection pool health and migration state.

Status Codes

  • Name
    200
    Type
    HTTP
    Description
    System is ready to accept traffic.
  • Name
    503
    Type
    HTTP
    Description
    Database is unavailable or migrations running.
Request
GET/api/v1/readyz
Response 200

API Modules Directory

We use cookies and similar technologies to measure traffic and improve the site. You can choose which categories to allow. Manage Preferences.