Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The San Francisco Compute Company Instance SKUs API

The Instance SKUs API from The San Francisco Compute Company — 4 operation(s) for instance skus.

The San Francisco Compute Company Instance SKUs API is one of 14 APIs that The San Francisco Compute Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Instance SKUs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.sfcompute.com.

4 operations 4 paths 16 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.sfcompute.com/preview/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

The San Francisco Compute Company Instance SKUs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Instance SKUs 4
GET
/preview/v2/instance_skus
List instance SKUs
list_instance_skus 3 params → 200401422500
GET
/preview/v2/instance_skus/availability
List instance-SKU availability
list_instance_sku_availability 14 params → 200401422500
GET
/preview/v2/instance_skus/{id}
Get instance SKU
get_instance_sku 1 param → 200401404500
GET
/preview/v2/instance_skus/{id}/availability
Get instance-SKU availability
get_instance_sku_availability 1 param → 200401404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are InstanceSku (14 properties), ListInstanceSkuAvailabilityResponse (4 properties), ListInstanceSkusResponse (4 properties), InstanceSkuSummary (3 properties). Each schema is shown below with its type and property counts.

InstanceSkusCursor
string
InstanceSkuId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
InternalServerError
object
1 property 1 required
InstanceSkuAvailability
object
One instance SKU's purchasable-capacity schedule.
3 properties 3 required
NotFoundError
object
1 property 1 required
Name
string
Schedule
array
Node count over time, as a list of [startat, endat) time ranges. Example: 5 nodes from t=0 to t=3600 is [{"startat": 0, "endat": 3600, "nodecount": 5}]. starta…
ScheduleEntry
object
A [startat, endat) time range with a fixed nodecount. endat is null only on the final entry, marking an unbounded tail.
3 properties 2 required
InstanceSkuSummary
object
A summary of an instance SKU - its id and human-recognizable alias - embedded on resources that reference a SKU.
3 properties 3 required
ListInstanceSkuAvailabilityResponse
object
Paginated per-SKU availability returned by GET /v2/instanceskus/availability.
4 properties 3 required
UnprocessableEntityError
object
1 property 1 required
ListInstanceSkusResponse
object
Paginated list of instance SKUs returned by GET /v2/instanceskus.
4 properties 3 required
UnixEpoch
integer
Unix timestamp.
InstanceSku
object
Instance SKU details. See [the instance SKUs guide](https://docs.sfcompute.com/preview/instance-skus).
14 properties 3 required
UnauthorizedError
object
1 property 1 required
ErrorDetail
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-instance-skus-api-openapi.yml Raw ↑

Other APIs The San Francisco Compute Company publishes across the network.

The San Francisco Compute Company Account API
The San Francisco Compute Company Deployments API
The San Francisco Compute Company Feature Flags API
The San Francisco Compute Company Images API
The San Francisco Compute Company Instance SKU Catalog API
The San Francisco Compute Company Instance Templates API
The San Francisco Compute Company Instances API
The San Francisco Compute Company Orderbook API
The San Francisco Compute Company Orders API
The San Francisco Compute Company Pools API
The San Francisco Compute Company Procurements API
The San Francisco Compute Company Users API