New:Microsoft Teams Notifications Are Now Available in Socket.Learn more →
Get Started

@roxyon/api-client

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@roxyon/api-client

Typed client for the Roxyon BaaS (RX engine) and the Roxyon Applications deploy API.

Source
npmnpm
Version
0.1.1
Version published
Weekly downloads
13
-45.83%
Maintainers
1
Weekly downloads
 
Created
Source

@roxyon/api-client

Typed TypeScript client for the Roxyon BaaS (the RX engine) and the Roxyon console's deploy endpoints. Plain fetch, no browser dependency — works in Node, the edge, and the browser.

npm i @roxyon/api-client
import { Roxyon } from '@roxyon/api-client';

// A session token from `roxyon login`, or a roxp_ personal access token.
const roxyon = new Roxyon({ sessionToken: process.env.ROXYON_TOKEN });

const ctx = await roxyon.account.context();      // user + subscriptions + domains
const apps = await roxyon.account.apps();
const logs = await roxyon.applications.logs(apps[0].id, 100);

What's in it

  • auth — /Auth/* login (email+password, OTP step-up), me, logout
  • account — context() (user + subs + domains), apps(), getApp()
  • applications — uploadSource() (deploy), deploy/restart, logs, getEnv/setEnv, repoConnect (git push-to-deploy)
  • sites — static-site publish
  • tokens — personal access token create / list / revoke
  • RUNTIMES, rxError, parseEnv/formatEnv, toQueryString

Notes

  • A roxp_… token authenticates the console endpoints (Authorization: Bearer); it is not a BaaS session token — resolve identity and subscriptions through account.context().
  • The BaaS resolves a failed write with an error field rather than rejecting. The write helpers here check for it and throw RoxyonApiError.

MIT · part of roxyon-devtools

FAQs

Package last updated on 02 Sep 2026

Related posts