@serve.zone/dcrouter-apiclient

Typed, object-oriented client for operating a running dcrouter instance. It wraps the OpsServer /typedrequest API in managers and resource classes so your scripts can work with routes, certificates, tokens, remote ingress edges, emails, stats, config, logs, and RADIUS without hand-rolling requests.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Installation

pnpm add @serve.zone/dcrouter-apiclient

You can also import the same client through the main package subpath:

import { DcRouterApiClient } from '@serve.zone/dcrouter/apiclient';

Quick Start

import { DcRouterApiClient } from '@serve.zone/dcrouter-apiclient';

const client = new DcRouterApiClient({
  baseUrl: 'https://dcrouter.example.com',
});

await client.login('admin', 'admin');

const { routes, warnings } = await client.routes.list();
console.log('route count', routes.length, 'warnings', warnings.length);

const route = await client.routes.build()
  .setName('api-gateway')
  .setMatch({ ports: 443, domains: ['api.example.com'] })
  .setAction({ type: 'forward', targets: [{ host: '127.0.0.1', port: 8080 }] })
  .save();

await route.toggle(false);

What the Client Gives You

Manager	Purpose
`client.routes`	List merged routes, create API routes, toggle routes
`client.certificates`	Inspect certificates and run certificate operations
`client.apiTokens`	Create, list, toggle, roll, and revoke API tokens
`client.remoteIngress`	Manage edge registrations, statuses, and connection tokens
`client.emails`	Inspect email items and trigger resend flows
`client.stats`	Health, statistics, and operational summaries
`client.config`	Read the current configuration view
`client.logs`	Read recent logs and log-related data
`client.radius`	Manage RADIUS clients, VLANs, and sessions

Authentication Modes

Mode	How it works
Admin login	Call `login(username, password)` and the returned identity is stored on the client
API token	Pass `apiToken` in the constructor and it is injected into requests automatically

const client = new DcRouterApiClient({
  baseUrl: 'https://dcrouter.example.com',
  apiToken: 'dcr_your_token_here',
});

Important behavior:

baseUrl is normalized, and the client automatically calls ${baseUrl}/typedrequest
buildRequestPayload() injects the current identity and optional API token for you
system routes can be toggled, but only API routes are meant for edit and delete flows

Route Builder Example

const newRoute = await client.routes.build()
  .setName('internal-app')
  .setMatch({
    ports: 443,
    domains: ['internal.example.com'],
  })
  .setAction({
    type: 'forward',
    targets: [{ host: '127.0.0.1', port: 3000 }],
  })
  .setEnabled(true)
  .save();

await newRoute.update({
  action: {
    type: 'forward',
    targets: [{ host: '127.0.0.1', port: 3001 }],
  },
});

Token and Remote Ingress Example

const token = await client.apiTokens.build()
  .setName('ci-token')
  .setScopes(['routes:read', 'routes:write'])
  .setExpiresInDays(30)
  .save();

console.log('copy this once:', token.tokenValue);

const edge = await client.remoteIngress.build()
  .setName('edge-eu-1')
  .setListenPorts([80, 443])
  .setAutoDerivePorts(true)
  .setTags(['production', 'eu'])
  .save();

const connectionToken = await edge.getConnectionToken();
console.log(connectionToken);

What This Package Does Not Do

It does not start dcrouter.
It does not bundle the dashboard.
It does not replace the raw interfaces package when you want low-level TypedRequest contracts.

Use @serve.zone/dcrouter to run the server and @serve.zone/dcrouter-interfaces for the shared request/data types.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

5.7 KiB Raw Blame History