Docs

API reference

Compute

Offers from outside providers, workload templates and instances, on the API host. No compute provider is connected yet, so everything but the templates answers 404.

Base URL https://api.siliconnetwork.io

List Offers

Offers from the connected compute providers, ranked (404 while none is connected).

silicon - zsh
curl https://api.siliconnetwork.io/v1/compute/offers \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

List Templates

The workload templates (static, answers whether or not a provider is connected).

silicon - zsh
curl https://api.siliconnetwork.io/v1/compute/templates \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

List Instances

The org's instances, newest first (key scope compute:read).

silicon - zsh
curl https://api.siliconnetwork.io/v1/compute/instances \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Create Instance

Start an instance (key scope compute:launch). 201 new, 200 replayed by its idempotency key.

silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/compute/instances \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Get Instance

One instance, its state asked of the provider first (key scope compute:read).

ParameterInTypeDescription
instance_id*pathstring
silicon - zsh
curl https://api.siliconnetwork.io/v1/compute/instances/{instance_id} \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Terminate Instance

Stop an instance; idempotent (key scope compute:launch).

ParameterInTypeDescription
instance_id*pathstring
silicon - zsh
curl -X POST https://api.siliconnetwork.io/v1/compute/instances/{instance_id}/terminate \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Instance Logs

Log lines after ``after``, oldest first (key scope compute:read).

ParameterInTypeDescription
instance_id*pathstring
silicon - zsh
curl https://api.siliconnetwork.io/v1/compute/instances/{instance_id}/logs \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Instance Console

A console link. The control plane hands these to a dashboard session only, so a key is refused there; forwarded so the answer says so.

ParameterInTypeDescription
instance_id*pathstring
silicon - zsh
curl https://api.siliconnetwork.io/v1/compute/instances/{instance_id}/console \
  -H "Authorization: Bearer sn_live_..."

Responses: 200 Successful Response, 422 Validation Error

Silicon Network›Docs›API›Compute50 items