@sylphx/management

Programmatic access to the Sylphx Platform Management API.

Installation

bun add @sylphx/management
# or
npm install @sylphx/management

Quick Start

import { SylphxManagement } from '@sylphx/management'

const mgmt = new SylphxManagement({
  token: process.env.SYLPHX_TOKEN!,
  // baseUrl: 'https://api.sylphx.com' (default)
})

// List projects
const projects = await mgmt.projects.list()

// Trigger a deployment
await mgmt.deployments.trigger('my-project-id', 'production')

// List env vars
const vars = await mgmt.envVars.list('my-project-id', 'production')

API

All methods are namespaced under the SylphxManagement instance:

mgmt.user

• whoami() — Get current user and orgs

mgmt.projects

• list() — List all projects
• create(data) — Create a new project
• delete(id) — Delete a project

mgmt.deployments

• status(projectId) — Get deployment status
• trigger(projectId, envType) — Trigger a deploy
• history(projectId, envType) — Get deployment history
• rollback(projectId, body) — Rollback to a previous deploy

mgmt.environments

• list(projectId) — List environments
• resolveId(projectId, envType) — Resolve envType → envId
• promote(projectId, targetEnvId, sourceEnvId) — Promote an environment

mgmt.envVars

• list(projectId, envType) — List env vars
• set(projectId, key, value, envType, secret?) — Set a single env var
• setMany(projectId, vars, envType) — Batch-set env vars
• delete(projectId, key, envType) — Delete an env var

mgmt.domains

• list(projectId, envType?) — List apex domains
• create(projectId, apexDomain, envType?) — Register a domain
• addHostname(projectId, domainId, hostname, opts?) — Add a hostname
• removeHostname(projectId, domainId, hostnameId) — Remove a hostname
• checkHostname(projectId, domainId, hostnameId) — Check DNS for hostname
• enableEmail(projectId, domainId, opts?) — Enable email sending
• checkEmail(projectId, domainId) — Check email DNS propagation
• disableEmail(projectId, domainId) — Disable email sending

mgmt.databases

• list() — List all databases
• create(data) — Provision a database
• get(id) — Get database details
• delete(id) — Delete a database
• branch(id, data) — Branch a database

mgmt.services

• list(projectId) — List services
• get(projectId, name) — Get a service
• deploy(projectId, name, envType) — Deploy a service
• delete(projectId, name) — Delete a service

mgmt.volumes

• list(projectId) — List volumes
• create(projectId, data) — Create a volume
• delete(projectId, volId) — Delete a volume

mgmt.storage

• list(projectId, envType?) — List storage resources
• create(projectId, data) — Provision storage
• delete(projectId, storageId) — Delete storage

mgmt.config

• list(projectId, envType?) — List config keys
• get(projectId, key, envType?) — Get a config key
• set(projectId, key, value, envType?) — Set a config key
• delete(projectId, key, envType?) — Delete a config key

mgmt.tasks

• list(projectId, envType?) — List task definitions
• create(projectId, data) — Create/update a task
• get(projectId, taskId) — Get a task
• update(projectId, taskId, data) — Update a task
• delete(projectId, taskId) — Delete a task

mgmt.resources

• listBindings(resourceId) — List resource bindings
• bind(resourceId, data) — Bind a resource to a project env
• unbind(resourceId, bindingId) — Unbind a resource

mgmt.org

• current() — Get current org
• listMembers(orgId) — List org members
• inviteMember(orgId, email, role) — Invite a member
• removeMember(orgId, userId) — Remove a member

mgmt.logs

• stream(projectId, envType) — Get { url, token } for SSE log streaming

Error Handling

import { ManagementApiError } from '@sylphx/management'

try {
  await mgmt.projects.delete('non-existent')
} catch (err) {
  if (err instanceof ManagementApiError) {
    console.error(`API Error ${err.status}: ${err.message}`)
  }
}

License

MIT