Shelf Cloud documentation
The Shelf Cloud API is AWS-shaped: point the tooling you already have at our endpoint and it works.
New here? Getting started takes you from signup to a machine you can SSH into in eight steps.
Every service has the same four documents: an overview, a user guide, a developer guide and an API reference.
Platform
Section titled “Platform”Platform — the contract every service shares: authentication, errors, pagination, idempotency, identifiers, regions, versioning, tenancy, metering, endpoints, consoles and the security model.
Compute
Section titled “Compute”Compute — the overview page: user guide, developer guide, API reference and cheat sheet.
EC2 — instances, volumes, snapshots, images, key pairs and tags. Instance types — every shape we sell and its AWS alias. Machine images — the OS shelf and the login user for each. Networking — default VPC, security groups, and the isolation gap that is still open. Instance metadata and user data — the config drive every guest gets, and what 169.254.169.254 will not do.
Storage
Section titled “Storage”Storage — the overview page.
Volume types — one type, what the disk actually is, and where the IOPS figure is not yet enforced. Volume actions — the EC2 API for block storage. Storage developer guide — the block-storage service v3 directly.
Guarantees
Section titled “Guarantees”What we verify before selling it — which claims on this site are checked by a machine rather than asserted.
Security
Section titled “Security”Credentials and trust — which of your secrets this platform can hand back to you, and what that means for blast radius.
Endpoints and consoles
Section titled “Endpoints and consoles”Service endpoints — the eleven hostnames this cloud publishes. Web console and VNC — seeing a machine that will not accept SSH.
Billing
Section titled “Billing”Billing — the overview page: user guide, developer guide and reference.
How prices are set — one rule,
computed, not typed.
Catalog and availability — the
public shop-window API, and how inStock is computed live.
Provider rate feed — every dimension
of the bill at every other provider, with sources.
Metering and invoicing — the
chain from what runs to what you are invoiced.
How a period is billed — the
guarantees behind an invoice line.
Account
Section titled “Account”Account — the overview page: user guide, developer guide and API reference.
Account API — catalog, prices, onboarding, billing portal. Access keys — the EC2 credentials SigV4 signs with, and how they differ from AWS. Usage and cost — what is running, what the month has cost, and the lag in that figure. Quotas and limits — what a new account may consume, and what is not capped at all.
Identity and access
Section titled “Identity and access”Identity — the overview page.
Identity, as deployed — what actually authenticates you, and every IAM concept mapped onto it. Access keys — the credential the EC2 API signs with.
The IAM and STS pages below are a specification for a service that is not deployed. Read them as a design document, not as an API you can call.
IAM — users, groups, policies and access keys. STS — short-lived credentials.
For models
Section titled “For models”Every page has a Markdown twin at the same URL plus .md, and the whole set is
listed in llms.txt and inlined in llms-full.txt.