The San Francisco Compute Company Workspaces API
Resource containers scoped to an account.
The San Francisco Compute Company Workspaces 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 Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 5 operations across 2 paths, and defines 17 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 Workspaces 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Resource containers scoped to an account.
Schemas 17
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are WorkspaceScope (4 properties), ListWorkspacesResponse (3 properties), ErrorDetail (3 properties), PatchWorkspaceRequest (1 property). 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.