Compute API

Compute API to deploy, scale, restart, roll back, and inspect container and VM workloads and Scalix Run services in Scalix Cloud.

REST API endpoints for Compute. 19 operations.

List deployments

plaintext

GET /v1/compute/deployments

Returns all compute deployments for the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	Deployment list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listDeployments

Create a deployment

plaintext

POST /v1/compute/deployments

Deploys a container/VM compute workload and returns the created deployment.

Auth: Bearer API key

Request body

application/json (required) — schema ComputeDeployRequest.

Responses

Status	Description
`201`	Deployment created
`401`	Missing or invalid API key
`500`	Internal error

operationId: createDeployment

Delete a deployment

plaintext

DELETE /v1/compute/deployments/{id}

Removes a compute deployment by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Responses

Status	Description
`200`	Deployment deleted
`401`	Missing or invalid API key
`500`	Internal error

operationId: deleteDeployment

Get a deployment

plaintext

GET /v1/compute/deployments/{id}

Returns a single compute deployment by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Responses

Status	Description
`200`	Deployment details
`401`	Missing or invalid API key
`500`	Internal error

operationId: getDeployment

List deployment instances

plaintext

GET /v1/compute/deployments/{id}/instances

Returns the running instances of a compute deployment.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Responses

Status	Description
`200`	Instance list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listDeploymentInstances

Get deployment logs

plaintext

GET /v1/compute/deployments/{id}/logs

Returns log output for a compute deployment.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Responses

Status	Description
`200`	Log output
`401`	Missing or invalid API key
`500`	Internal error

operationId: getDeploymentLogs

Restart a deployment

plaintext

POST /v1/compute/deployments/{id}/restart

Restarts all instances of a compute deployment.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Responses

Status	Description
`200`	Deployment restarted
`401`	Missing or invalid API key
`500`	Internal error

operationId: restartDeployment

Roll back a deployment

plaintext

POST /v1/compute/deployments/{id}/rollback

Rolls a compute deployment back to a previous version.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Request body

application/json (required) — schema object.

Responses

Status	Description
`200`	Deployment rolled back
`401`	Missing or invalid API key
`500`	Internal error

operationId: rollbackDeployment

Scale a deployment

plaintext

POST /v1/compute/deployments/{id}/scale

Adjusts the instance count (min/max) for a compute deployment.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Request body

application/json (required) — schema object.

Responses

Status	Description
`200`	Deployment scaled
`401`	Missing or invalid API key
`500`	Internal error

operationId: scaleDeployment

List deployment versions

plaintext

GET /v1/compute/deployments/{id}/versions

Returns the version history of a compute deployment.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Deployment id

Responses

Status	Description
`200`	Deployment versions
`401`	Missing or invalid API key
`500`	Internal error

operationId: listDeploymentVersions

List Scalix Run services

plaintext

GET /v1/run/services

Returns all Scalix Run services for the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	Service list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listServices

Deploy a Scalix Run service

plaintext

POST /v1/run/services

Deploys a Scalix Run service and returns the created service.

Auth: Bearer API key

Request body

application/json (required) — schema RunServiceDeployRequest.

Responses

Status	Description
`201`	Service deployed
`401`	Missing or invalid API key
`500`	Internal error

operationId: createService

Delete a Scalix Run service

plaintext

DELETE /v1/run/services/{id}

Removes a Scalix Run service by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Responses

Status	Description
`200`	Service deleted
`401`	Missing or invalid API key
`500`	Internal error

operationId: deleteService

Get a Scalix Run service

plaintext

GET /v1/run/services/{id}

Returns a single Scalix Run service by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Responses

Status	Description
`200`	Service details
`401`	Missing or invalid API key
`500`	Internal error

operationId: getService

Update a Scalix Run service

plaintext

PUT /v1/run/services/{id}

Updates a Scalix Run service (e.g. scaling) and returns the new state.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Request body

application/json (required) — schema RunServiceUpdateRequest.

Responses

Status	Description
`200`	Service updated
`401`	Missing or invalid API key
`500`	Internal error

operationId: updateService

List service instances

plaintext

GET /v1/run/services/{id}/instances

Returns the running instances of a Scalix Run service.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Responses

Status	Description
`200`	Service instances
`401`	Missing or invalid API key
`500`	Internal error

operationId: listServiceInstances

Get service live instance state

plaintext

GET /v1/run/services/{id}/metrics

Returns healthy/total instance counts and in-flight request totals for a Scalix Run service. Request-level RED metrics (requests/sec, errors/sec, latency percentiles) are served by GET /v1/metering/services/run-service/{id}/metrics, whose response carries available:false with a message when the deployment has no metrics backend.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Responses

Status	Description
`200`	Live instance state
`401`	Missing or invalid API key
`500`	Internal error

operationId: getServiceMetrics

List service revisions

plaintext

GET /v1/run/services/{id}/revisions

Returns the revision history of a Scalix Run service.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Responses

Status	Description
`200`	Service revisions
`401`	Missing or invalid API key
`500`	Internal error

operationId: listServiceRevisions

Roll back a service

plaintext

POST /v1/run/services/{id}/rollback

Rolls a Scalix Run service back to a previous revision.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Service id

Request body

application/json (required) — schema object.

Responses

Status	Description
`200`	Service rolled back
`401`	Missing or invalid API key
`500`	Internal error

operationId: rollbackService