Skip to main content
Servers Are Up
Virtual Datacenter
PricingFree Tools
Sign inBrowse catalog
Servers Are Up
Virtual Datacenter
PricingFree Tools
Sign inBrowse catalog

Loading…

Servers Are Up

Your apps, automation and data on hardware we own. Build a private stack with predictable capacity and access through your dashboard, API or SSH.

SLA with service creditsOwned hardwareUS-based

Make room for your next idea

Explore the capacity, apps and access options that fit your workload. Check current availability and your total before you buy.

Sign up freeView Pricing

Products

  • Linux VPS
  • Windows VPS
  • Cloud & SaaS Services
  • Cloud Storage (Azure)
  • Virtual Datacenter
  • AI & Agent Hosting
  • Containers
  • Instant Apps
  • Software Platforms
  • Network builder
  • Game Servers
  • Pricing

Resources

  • Free Network Tools
  • 2026 Pricing Benchmark
  • Live SVG Badges
  • Latency & Speed Test
  • Guides & Tutorials
  • Documentation
  • API Reference
  • MCP Server
  • CLI & SDKs
  • OpenAPI & llms.txt
  • Use Cases
  • Free Migration
  • Uptime & Reliability
  • Datacenter
  • System Status
  • Network
  • Provider Comparisons Hub
  • Compare Providers

Company

  • About Us
  • Enterprise
  • Security Architecture
  • Trust Center
  • Blog
  • FAQ
  • Compliance
  • Startup Program
  • Open-Source Sponsorship
  • Press & Media Kit
  • Referral Program
  • Help Center
  • Contact Us
© Servers Are Up
TermsPrivacySLARefund PolicyDPAAcceptable Use
Service information
Docs
  • Documentation Hub
  • Choose a Product
    VMs, Containers & Cloud
  • First Linux Server
    SSH, Firewall & Apps
  • Windows Server 2025
    BYOL & Remote Desktop
  • Remote Access
  • Troubleshooting
  • FAQ
  • All Product Guides
    29 Step-by-Step Guides
  • Cloud & SaaS Catalog
    112 Cloud & SaaS Offerings
  • Azure Cloud Storage
    Hot/Cool/Archive & WORM
  • Resource Manager & RBAC
    Groups, Tags & Locks
  • Multi-Model Cloud DB
    JSONB, SQL & pgvector
  • Cloud Identity & ZTNA
    OIDC, SCIM & PIM
  • Key Vault & KMS
    Secrets & Envelope Keys
  • Cloud SIEM, SOAR & DLP
    Posture & Threat Response
  • API Gateway & Cloud DNS
    Edge WAF & DNS Zones
  • Serverless, Workflows & IoT
    Functions, Queues & DAGs
  • SaaS, Governance & Vault
    Budgets & Off-Host GRS
  • Build Web Apps with AI
  • Next.js and React
  • TypeScript and Node.js
  • npm and Tooling
  • Data and APIs
  • Deploy and Operate
  • Tutorials
  • Infrastructure
  • Automation & Regions
  • API Overview
  • API v1 Reference
    Endpoints & 23 Scopes
  • MCP Server
    129 AI Agent Tools
  • Swagger / OpenAPI 3.1
  • API Playground
  • Versioning & Sunset
  • API Token Security
    Authentication & Tokens
  • Instances API
    Compute Resources
  • Networking API
    Networks & Ports
  • Storage API Availability
    Volumes & Backups
  • Webhooks & Events
    Event Notifications
  • Rate Limits & Best Practices
    Throttling & Retries
  • sau CLI Reference
    34 Commands (v0.2)
  • Browser Web CLI
  • SDKs
  • Infrastructure as Code
    Terraform & Ansible
  • Code Examples
  • CLI & SDK Guides
  • Security Guides
  • Security at a Glance
  • Zero Trust Architecture
  • Live Trust Center
  • Compliance
Need help?

Loading documentation...

Documentation/products

Create a scoped API key and send your first v1 request

Mint a least-privilege sau_ Personal Access Token across 23 scopes and call the 140-path Servers Are Up REST API v1 safely.

Beginner
12 min
Updated 2026-11-12

Deploy Ready-to-Run Infrastructure in Seconds

Linux VMs from $6/mo · Pooled Virtual Datacenters from $12/mo · Use code WELCOME20 for 20% off your first order.

Browse ServersView Pricing

Commands checked on 2026-11-12 with Servers Are Up REST API v1 (OpenAPI 3.1), curl 8.5, jq 1.7.

What you will have at the end

You will have a least-privilege sau_ Personal Access Token stored safely outside source code, verified connectivity against zero-auth discovery endpoints and authenticated /api/v1/* routes (140 OpenAPI paths, 222 operations), and working patterns for Idempotency-Key headers, rate-limit inspection, and error handling.

Before you start

  • A Servers Are Up account signed in at /dashboard (or an organization workspace where you hold Owner/Admin rights).
  • curl and jq installed in your terminal.
  • Remember the single canonical API base URL: https://serversareup.com/api/v1 (machine-readable OpenAPI 3.1 spec at https://serversareup.com/openapi.json).

Steps

1. Call zero-auth discovery endpoints first

Several v1 endpoints require no authentication at all so scripts and AI agents can inspect API health, live catalog pricing, and workload recommendations immediately:

curl -fsSL "https://serversareup.com/api/v1/version" | jq .
curl -fsSL "https://serversareup.com/api/v1/catalog?type=VM" | jq '.products[:3] | map({slug, name, priceCents, purchasable})'
curl -fsSL "https://serversareup.com/api/v1/recommend?workload=linux-standard&budgetUsd=35" | jq '.recommendations[0]'

2. Mint a least-privilege Personal Access Token (sau_...)

Open Account settings > API keys (/account/api-keys)—or /orgs/<id>/admin/api-keys for an organization-scoped token—and click Create API key:

  1. Name the token after the single system that will hold it (for example github-actions-deploy or laptop-sau-cli).
  2. Set an expiration date (30 or 90 days recommended for CI/CD runners).
  3. Select only the scopes that workflow needs from the 23 canonical v1 scopes (wildcard * scopes are explicitly rejected with 400 Bad Request so no token silently bypasses authorization):
    • Compute & Guest Ops: instances:read, instances:write, instances:power, instances:exec, instances:files:read, instances:files:write
    • Snapshots & Backups: snapshots:read, snapshots:write
    • Network & SSH: network:read, network:write, ssh-keys:read, ssh-keys:write
    • Storage & Billing: storage:read, storage:write, billing:read, billing:write, catalog:read
    • Cloud Platform & Resource Manager: cloud:read, cloud:write (covers /api/v1/resource-manager, /cosmos, /blob-storage, /vault/*, /sentinel, /defender-purview, /entra-suite, /apim, /cloud-dns, /serverless-compute, /workflows, /app-config, /service-bus, /iot-chaos, /governance, /recovery-vault, and /cloud-services)
    • Telemetry & Account: account:read, activity:read, usage:read, webhooks:read, webhooks:write (isos:read/isos:write are legacy compatibility scopes)

Copy the sau_... secret immediately—the server stores only its cryptographic hash and prefix, so the plaintext secret is never shown again.

3. Send your first authenticated read requests

Export SAU_API_TOKEN in your terminal session (prefix the export with a leading space in bash/zsh if HISTCONTROL=ignorespace is enabled) and query your account, servers, and Resource Groups:

export SAU_API_TOKEN="sau_your_token_here"

# Inspect token owner and organization context (account:read)
curl -fsSL "https://serversareup.com/api/v1/account" \
  -H "Authorization: Bearer ${SAU_API_TOKEN}" | jq .

# List your servers (instances:read)
curl -fsSL "https://serversareup.com/api/v1/instances" \
  -H "Authorization: Bearer ${SAU_API_TOKEN}" | jq '.instances | map({id, name, status, publicIp})'

# List Resource Groups and active Management Locks (cloud:read)
curl -fsSL "https://serversareup.com/api/v1/resource-manager?section=overview" \
  -H "Authorization: Bearer ${SAU_API_TOKEN}" | jq '{groups: (.resourceGroups | length), locks: (.locks | length)}'

4. Know how state-changing mutations, orders, and Idempotency-Key work

Keep four important API contracts in mind when writing automation:

  1. Ordering new servers: POST /api/v1/instances answers 405 Method Not Allowed. New catalog servers are purchased through POST /api/v1/orders (or its alias POST /api/v1/deploy) with billing:write + instances:write scopes and a unique Idempotency-Key header (8–200 chars) so network retries never double-charge.
  2. Updating server metadata: PATCH /api/v1/instances/{id} updates name and tags (hostname in PATCH returns 400 Bad Request).
  3. Async provider lifecycle commands: Power actions, resize, rebuild, port forwards, snapshots, backups, and soft-delete (DELETE /api/v1/instances/{id}) enqueue a durable provider command and return 202 Accepted.
  4. Management Locks: If a resource or its Resource Group carries a ReadOnly or CanNotDelete lock, destructive POST/DELETE mutations return 409 Conflict (RESOURCE_LOCKED) before touching infrastructure.
# Rename a server and attach structured tags (instances:write)
curl -fsSL -X PATCH "https://serversareup.com/api/v1/instances/YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer ${SAU_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"name":"prod-api-01","tags":["env:prod","tier:backend"]}' | jq .

Check that it works

Verify both a 200 OK authorized call and inspect rate-limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) on the response:

curl -fsSI "https://serversareup.com/api/v1/instances" \
  -H "Authorization: Bearer ${SAU_API_TOKEN}" | grep -iE "^HTTP/|^x-ratelimit"

Open Operations > Activity log (/dashboard/activity) (or run sau monitor activity-log) to see your API token calls recorded in your tenant audit trail.

What can go wrong

  • 401 Unauthorized even after pasting the token. Check for trailing newlines when base64-decoding secrets in CI (echo -n "$TOKEN" instead of echo), confirm the header reads Authorization: Bearer sau_..., and verify you are calling https://serversareup.com/api/v1/....
  • 403 Forbidden with insufficient_scope. The error JSON names the exact missing scope (for example cloud:write or instances:power). Mint a replacement token on /account/api-keys with that scope rather than reusing an over-privileged admin token everywhere.
  • 429 Too Many Requests during parallel fleet scripts. Read the Retry-After response header and back off exponentially with jitter rather than retrying in a tight loop.

Good practice

  • Separate read-only observability tokens (instances:read, cloud:read, activity:read) from mutating deployment tokens so dashboards, AI assistants, and monitoring scripts cannot alter production state.
  • Always pass a deterministic Idempotency-Key header on POST /api/v1/orders, POST /api/v1/deploy, and permanent instance deletions.
  • Validate request and response shapes directly from https://serversareup.com/openapi.json (note that standalone Python, Node.js, and Go SDK packages on PyPI/npm are Coming soon and not published today—use direct fetch/httpx, @serversareup/cli, or @serversareup/mcp-server).

Where to go next

  • Install the sau CLI and manage infrastructure from a terminal
  • Connect an AI agent to Servers Are Up over MCP
  • Organize resources with groups, tags, locks and RBAC

Related Articles

Route APIs with Edge WAF, rate limits and Cloud DNS

Read more

Purchase Azure-backed cloud storage with WORM locks and SAS

Read more

Snapshot a server before a change and restore safely

Read more

Frequently Asked Questions

What does the Create a scoped API key and send your first v1 request documentation guide cover?
Mint a least-privilege sau_ Personal Access Token across 23 scopes and call the 140-path Servers Are Up REST API v1 safely. It is rated beginner difficulty (12 min) and applies to Servers Are Up infrastructure and workflows.
Can I manage or automate these steps through the Servers Are Up dashboard, REST API v1, or MCP server?
Yes. Every Servers Are Up server includes browser-based SSH, WebRDP, and VNC console access in the dashboard, plus programmatic control via the REST API v1 (/api/v1) and hosted Model Context Protocol server (/api/mcp/v1) using a scoped Personal Access Token.

Need hands-on help with Create a scoped API key and send your first v1 request?

Every Servers Are Up virtual machine and container includes an integrated HTML5 browser-based SSH, RDP, and VNC console in your dashboard, default-off inbound firewall rules with per-IP allow-lists, and full programmatic control via REST API v1 and Model Context Protocol (MCP). Explore our Virtual Datacenter Plans or reach out to Servers Are Up Support.

Was this article helpful?

On this page

What you will have at the endBefore you startSteps1. Call zero-auth discovery endpoints first2. Mint a least-privilege Personal Access Token (sau_...)3. Send your first authenticated read requests4. Know how state-changing mutations, orders, and Idempotency-Key workCheck that it worksWhat can go wrongGood practiceWhere to go next