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

Custom machine images for instances.

The San Francisco Compute Company Images 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 Images. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 9 operations across 7 paths, and defines 25 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.

9 operations 7 paths 25 schemas 1 DELETE3 GET5 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 Images 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 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Images 9

Custom machine images for instances.

POST
/preview/v2/images
Create image
create_image body → 201400401403409500
GET
/preview/v2/images
List images
list_images 5 params → 200400401403500
DELETE
/preview/v2/images/{id}
Delete image
delete_image 1 param → 200401403404409500
GET
/preview/v2/images/{id}
Get image
fetch_image 1 param → 200401403404500
POST
/preview/v2/images/{id}/complete
Complete image upload
complete_image_upload 1 param body → 200400401403404500
GET
/preview/v2/images/{id}/download
Download image
download_image 1 param → 200401403404409500
POST
/preview/v2/images/{id}/parts
Get upload part URL
create_image_upload_part_url 1 param body → 200400401403404500
POST
/preview/v2/images/{id}/reinstate
Reinstate image
reinstate_image 1 param → 200401403404409500
POST
/preview/v2/images/{id}/revoke
Revoke image
revoke_image 1 param → 200401403404409500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ImageScope (7 properties), ListImagesResponse (4 properties), ImageDownloadResponse (4 properties), ErrorDetail (3 properties). Each schema is shown below with its type and property counts.

ListImagesResponse
object
4 properties 3 required
InternalServerError
object
1 property 1 required
CompleteUploadRequest
object
Complete a multipart image upload.
1 property 1 required
StartUploadRequest
object
Start a multipart image upload. Max image size is 128 GiB.
2 properties 1 required
ErrorDetail
object
3 properties 2 required
ImageListEntry
WorkspaceId
string
ConflictError
object
1 property 1 required
ImageScope
object
7 properties 7 required
BadRequestError
object
1 property 1 required
ImagesCursor
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
UploadPartRequest
object
1 property 1 required
NotFoundError
object
1 property 1 required
DeleteImageResponse
object
3 properties 3 required
ImageUploadResponse
imageResourcePath_ImageId
string
A resource path for a image resource. Format: sfc:image: : : .
ImageUploadStatus
string
Name
string
ImageDownloadResponse
object
4 properties 4 required
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…
UnixEpoch
integer
Unix timestamp.
UploadPartResponse
object
2 properties 2 required
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-images-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 Instance SKU Catalog API
The San Francisco Compute Company Instance SKUs 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