Cloud API quickstart

1. Get a token

Sign in, open the Dashboard, and create an API Token under your account settings. Set the PIDGINHOST_API_TOKEN environment variable.

2. List available server packages

curl -X GET https://www.pidginhost.com/api/v1/cloud/server-packages/ \
  -H "Authorization: Token $PIDGINHOST_API_TOKEN"

3. Create a VM

curl -X POST https://www.pidginhost.com/api/v1/cloud/servers/ \
  -H "Authorization: Token $PIDGINHOST_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "hostname": "web-01",
    "package": "cloudv-4",
    "image": "ubuntu24",
    "ssh_pub_key": "ssh-ed25519 AAAA..."
  }'

Response includes the new server id. Poll the server detail endpoint until status becomes active.

4. Same flow with phctl CLI

phctl auth login --token "$PIDGINHOST_API_TOKEN"
phctl compute server create \
  --hostname web-01 \
  --package cloudv-4 \
  --image ubuntu24