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 Templates API

Reusable instance configuration.

The San Francisco Compute Company Instance Templates 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 Templates. 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 2 paths, and defines 23 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 2 paths 23 schemas 1 DELETE2 GET1 POST

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 Templates 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 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Instance Templates 4

Reusable instance configuration.

POST
/preview/v2/instance_templates
Create instance template
create_instance_template body → 201401403422500
GET
/preview/v2/instance_templates
List instance templates
list_instance_templates 6 params → 200401403422500
DELETE
/preview/v2/instance_templates/{id}
Delete instance template
delete_instance_template 1 param → 204401403404422500
GET
/preview/v2/instance_templates/{id}
Get instance template
fetch_instance_template 1 param → 200401403404500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are InstanceTemplateScope (6 properties), CreateInstanceTemplateRequest (5 properties), ListInstanceTemplatesResponse (4 properties), ErrorDetail (3 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
1 property 1 required
instance_templateResourcePath_InstanceTemplateId
string
A resource path for a instancetemplate resource. Format: sfc:instancetemplate: : : .
UnprocessableEntityError
object
1 property 1 required
ErrorDetail
object
3 properties 2 required
WorkspaceId
string
InstanceTemplateScope
object
6 properties 6 required
InstanceTemplateInclude
string
ImageId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
UnauthorizedError
object
1 property 1 required
NotFoundError
object
1 property 1 required
ResourcePathOrId_ImageId
string
A resource path like 'sfc:image:acme:prod:my-image' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or move…
ImageSummary
object
2 properties 2 required
CreateInstanceTemplateRequest
object
5 properties 2 required
Tags
object
Name
string
InstanceTemplatesCursor
string
InstanceTemplateId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
InstanceTemplateResponse
ResourcePathOrId_WorkspaceId
string
A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or m…
ResourcePathOrId_InstanceTemplateId
string
A resource path like 'sfc:instancetemplate:acme:prod:my-instancetemplate' or an ID. Resource paths are human-readable but not stable - they change when resourc…
ListInstanceTemplatesResponse
object
4 properties 3 required
UnixEpoch
integer
Unix timestamp.
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-instance-templates-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 SKUs 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