Getting Started

Quick Start

Welcome to Puchify. This guide gets you from zero to managing your first server in minutes.

Once signed in, you'll land on the Observability dashboard.

Navigate to Settings → API Keys and click Create API Key.

Give it a name like "development" and copy the generated key. You'll only see it once — keep it safe.

Store it as an environment variable:

export PUCHIFY_API_KEY=pk_xxxx

Using the CLI:

npx puchify servers create \
  --name web-01 \
  --plan shared-2 \
  --region us-east \
  --image ubuntu-24.04

Or with the TypeScript SDK:

import { Puchify } from "@puchify/sdk"

const puchify = new Puchify({ apiKey: process.env.PUCHIFY_API_KEY })
const { data: server } = await puchify.servers.create({
  name: "web-01",
  plan: "shared-2",
  region: "us-east",
  image: "ubuntu-24.04",
})

console.log(`Server ${server.id} is ${server.status}`)

Or with curl:

curl -X POST https://api.puchify.com/api/v1/servers \
  -H "Authorization: Bearer $PUCHIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"web-01","plan":"shared-2","region":"us-east"}'

Server creation is async. The server starts in creating state and transitions to running once provisioned.

puchify servers list --status running

Or poll programmatically:

const server = await puchify.servers.waitFor("svr_abc123", "running", {
  timeout: 300_000,
  pollInterval: 5_000,
})
console.log(`Server ${server.name} is running at ${server.ipv4}`)