Skip to main content

Quickstart

This guide gets you from zero to a working API call in five minutes. You will authenticate, list your VPCs, and explore the interactive reference.

Prerequisites​

  • A WebberStop portal account at portal.webberstop.com.
  • curl and jq installed locally. On macOS: brew install jq. On Ubuntu: apt install jq.

Step 1: Get a token​

TOKEN=$(curl -s https://portal.webberstop.com/backend/api/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@yourcompany.com","password":"your-password"}' \
  | jq -r '.token')

echo "$TOKEN" | cut -c1-40

You should see the first 40 characters of a long JWT string like eyJhbGciOiJIUzI1NiIs....

If your account has MFA enabled, see the Authentication guide for the additional /mfa/send-otp and /mfa/verify-otp steps.

Step 2: List your VPCs​

curl -s https://portal.webberstop.com/backend/api/vpcs \
  -H "Authorization: Bearer $TOKEN" \
  | jq

You should get a JSON response listing every VPC in your account, even if it is empty:

{
  "vpcs": [],
  "total": 0
}

Step 3: List zones, offerings, and templates​

These IDs are the building blocks for every other API call. Cache them locally.

# Zones
curl -s https://portal.webberstop.com/backend/api/zones \
  -H "Authorization: Bearer $TOKEN" \
  | jq '.zones[] | {id, name}'

# VPC offerings
curl -s https://portal.webberstop.com/backend/api/vpc-offerings \
  -H "Authorization: Bearer $TOKEN" \
  | jq '.vpcOfferings[] | {id, name}'

# Network offerings for VPC tiers
curl -s "https://portal.webberstop.com/backend/api/network-offerings?forVpc=true" \
  -H "Authorization: Bearer $TOKEN" \
  | jq '.networkOfferings[] | {id, name}'

# Compute offerings
curl -s https://portal.webberstop.com/backend/api/service-offerings \
  -H "Authorization: Bearer $TOKEN" \
  | jq '.serviceOfferings[] | {id, name, cpuNumber, memory}'

# OS templates
curl -s "https://portal.webberstop.com/backend/api/templates?type=featured" \
  -H "Authorization: Bearer $TOKEN" \
  | jq '.templates[] | {id, name, osType}'

Save the IDs you plan to use. A typical workflow needs:

  • Zone ID, for example Noida01
  • VPC offering ID, usually Default VPC Offering
  • Network offering ID for VPC tiers, usually DefaultIsolatedNetworkOfferingForVpcNetworks
  • Service offering ID, for example General Purpose 2vCPU 8GB
  • Template ID, for example Ubuntu 22.04 LTS

Step 4: Explore the Swagger UI​

Open https://portal.webberstop.com/backend/api/docs/administrator in your browser.

  1. Click Authorize at the top right.
  2. Paste your JWT in the format Bearer eyJhbGciOiJIUzI1NiIs....
  3. Click Authorize, then Close.
  4. Expand any endpoint, click Try it out, fill the parameters, and click Execute.

The Swagger UI shows the exact request that was sent, the full response, and any errors. It is the fastest way to learn the shape of each endpoint.

Next steps​