How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The San Francisco Compute Company Deployments API

Deployment automations that maintain a fleet of instances, including spot deployments that buy capacity up to a maximum price.

The San Francisco Compute Company Deployments 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 Deployment. 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 43 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

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

5 operations 2 paths 43 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Deployments 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.

Deployments 5

Deployment automations that maintain a fleet of instances, including spot deployments that buy capacity up to a maximum price.

POST
/preview/v2/deployments
Create deployment
create_deployment body → 201400401403409422500
GET
/preview/v2/deployments
List deployments
list_deployments 5 params → 200401403422500
DELETE
/preview/v2/deployments/{id}
Delete deployment
delete_deployment 1 param → 204401403404500
GET
/preview/v2/deployments/{id}
Get deployment
get_deployment 1 param → 200401403404500
PATCH
/preview/v2/deployments/{id}
Update deployment
patch_deployment 1 param body → 200400401403404422500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are CreateSpotDeploymentRequest (7 properties), PatchDeploymentRequest (6 properties), SpotDeploymentScope (6 properties), DeploymentScope (6 properties). Each schema is shown below with its type and property counts.

spot_deploymentResourcePath_SpotDeploymentId
string
A resource path for a spotdeployment resource. Format: sfc:spotdeployment: : : .
Name
string
BadRequestError
object
1 property 1 required
CreateSpotDeploymentRequest
object
A spot deployment buys capacity for a specific instance SKU at or below a maximum rate, then maintains a target number of instances on that capacity.
7 properties 5 required
deploymentResourcePath_DeploymentId
string
A resource path for a deployment resource. Format: sfc:deployment: : : .
DeploymentScope
object
6 properties 6 required
InstanceTemplateId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
PatchDeploymentRequest
object
6 properties
NotFoundError
object
1 property 1 required
UnprocessableEntityError
object
1 property 1 required
DeploymentId
string
CapacitySummary
object
2 properties 2 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…
ResourcePathOrId_DeploymentId
string
A resource path like 'sfc:deployment:acme:prod:my-deployment' or an ID. Resource paths are human-readable but not stable - they change when resources are renam…
DollarsPerNodeHour
string
Price rate in dollars per node-hour.
CreateDeploymentRequest
object
A generic deployment maintains a target number of instances using capacity already owned in a pool. It does not buy additional capacity.
6 properties 4 required
PoolSummary
object
A pool referenced by id and name.
2 properties 2 required
ForbiddenError
object
1 property 1 required
DeploymentResponse
AutomationStatus
string
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…
InstanceSkuId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
ResourcePathOrId_SpotDeploymentId
string
A resource path like 'sfc:spotdeployment:acme:prod:my-spotdeployment' or an ID. Resource paths are human-readable but not stable - they change when resources a…
ConflictError
object
1 property 1 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
WorkspaceId
string
ErrorDetail
object
3 properties 2 required
DeploymentResource
InternalServerError
object
1 property 1 required
UnauthorizedError
object
1 property 1 required
UnixEpoch
integer
Unix timestamp.
SpotDeploymentScope
object
6 properties 6 required
SpotDeploymentResponse
A spot deployment buys compute up to a maximum price and runs instances on the secured pool.
ResourcePathOrId_PoolId
string
A resource path like 'sfc:pool:acme:prod:my-pool' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved.…
SpotDeploymentId
string
CreateDeploymentResourceRequest
InstanceTemplateSummary
object
2 properties 2 required
ListDeploymentsResponse
object
4 properties 3 required
CapacityId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
PoolId
string
ReconciliationStatus
object
2 properties 2 required
NameTemplate
string
A name template using {{variable}} syntax. Available variables: {{adjective}} (~128 random adjectives), {{noun}} (~128 random nouns), {{nanoid(N)}} (N-characte…
DeploymentsCursor
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-deployments-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 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 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
Where this information came from

This is an independent, third-party profile of The San Francisco Compute Company Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.