Developers

Build on Buildfyio

Everything the dashboard does is an API call you can make too: from a script, a CI job, a terminal or an AI agent.

REST API

A JSON API at https://api.buildfyio.com/v1: workspaces, projects, deployments, logs (SSE), environment variables and domains. The OpenAPI document is published at /v1/openapi.json for codegen.

curl -s https://api.buildfyio.com/v1/orgs \
  -H "Authorization: Bearer $BUILDFY_TOKEN"

API tokens

Tokens start with bfy_ and go in Authorization: Bearer bfy_…. Each one carries permissions (read, deploy, env:read, env:write, domains, admin), can be bound to one workspace, and can expire. A missing permission answers 403 insufficient_scope. In CI, set BUILDFY_TOKEN and the CLI skips login.

buildfy tokens create --name ci --scopes read,deploy --expires 90d
BUILDFY_TOKEN=bfy_… buildfy deploy --prod --branch main

CLI

@fyio/buildfyio-cli installs the buildfy binary: deploy, roll back, stream logs, explain a failed build, sync env vars, manage domains, cron jobs and tokens.

npm i -g @fyio/buildfyio-cli   # binary: buildfy
buildfy login
buildfy link                    # link this directory to a project
buildfy deploy                  # production deploy of the current branch
buildfy logs                    # latest deployment, build stream
buildfy errors                  # why the newest failed deployment failed

TypeScript SDK

@fyio/buildfyio-sdk is a typed client generated from the same OpenAPI spec: projects, deployments, env vars and an async iterator over log streams.

$npm i @fyio/buildfyio-sdk
import { Buildfyio } from '@fyio/buildfyio-sdk';

const client = new Buildfyio({ token: process.env.BUILDFYIO_TOKEN!, orgId: 'org_xxx' });
const dep = await client.deployments.trigger('org_xxx', 'prj_yyy', { env: 'production', branch: 'main' });

MCP server for AI agents

A hosted MCP server at https://mcp.buildfyio.com/mcp. Add it to Claude as a custom connector and sign in, with no token to paste. Agents can list projects, deploy, roll back, read logs and explain failed builds, limited by the permissions you grant. For Claude Code, Cursor, Windsurf or Claude Desktop the CLI wires it up:

$buildfy mcp install claude-code

Or by hand, with a token:

claude mcp add --scope user --transport http buildfyio https://mcp.buildfyio.com/mcp --header "Authorization: Bearer <token>"

Prefer to run it yourself? npx -y @fyio/buildfyio-mcp starts the same tools as a local stdio server.

Webhooks

Register endpoints per project or workspace on the Hooks tab and pick events: deployment.created, deployment.ready, deployment.failed, deployment.cancelled, domain.verified, domain.failed and alert.fired. Every delivery is signed with X-Buildfyio-Signature and carries X-Buildfyio-Delivery for de-duplication.

Status API

A Statuspage-compatible summary at /api/v2/summary.json (also on status.buildfyio.com), CORS-open and cached for 30 seconds, for badges and in-app banners. Incidents are also published as RSS and Atom.

$curl -s https://buildfyio.com/api/v2/summary.json