The San Francisco Compute Company Instances API
Spin up instances in a capacity to use your available compute.
The San Francisco Compute Company Instances 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 Instances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 10 operations across 6 paths, and defines 49 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
The San Francisco Compute Company Instances 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 10
Across 6 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Spin up instances in a capacity to use your available compute.
Schemas 49
The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are CreateInstanceRequest (10 properties), InstanceScope (6 properties), InstanceSshInfo (5 properties), InstanceLogChunk (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from The San Francisco Compute Company 12
Other APIs The San Francisco Compute Company publishes across the network.