REST API Reference

Workloads API

Deploy, scale, restart, rollback, pause, resume, inspect, and export container workloads running on managed Kubernetes clusters.

Create Workload

Deploys a containerized workload into a project namespace.

Create WorkloadAuth

Provision a container workload with replicas and port mapping.

Payload Example

{
  "project_id": "proj_prod_store_9a1b",
  "name": "api-gateway",
  "image": "vyntech/gateway:v1.2.0",
  "replicas": 3,
  "port": 8080,
  "cpu_limit": "1000m",
  "memory_limit": "1Gi",
  "env": {
    "NODE_ENV": "production",
    "LOG_LEVEL": "info"
  }
}

Status Codes

Name
201
Type
HTTP
Description
Workload created and pod scheduling initiated.
Name
400
Type
HTTP
Description
Invalid container image tag or exceeding project quota.

Request

POST/v1/cloud/workloads

Response 201

Scale Workload

Adjust the desired number of running container replica pods.

Scale ReplicasAuth

Update desired pod replica count.

Payload Example

{ "replicas": 5 }

Status Codes

Name
200
Type
HTTP
Description
Workload scale target updated.

Request

POST/v1/cloud/workloads/{id}/scale

Response 200