Skip to content

Κλοηγός / Kloigos API

Version: 0.2.0

Base URL: /api

🗂️ compute_units

🟩 POST /compute_units/allocate

Allocate

Request body (JSON): ComputeUnitRequest

Responses:

  • ✅ 200 → ComputeUnitResponse

  • ❌ 422 → HTTPValidationError

🟥 DELETE /compute_units/deallocate/{compute_id}

Deallocate

Parameters:

  • ❗ compute_id 🔤

Responses:

  • ✅ 200 → {}

  • ❌ 422 → HTTPValidationError

🟦 GET /compute_units/

List Servers

Returns a list of all servers. Optionally filter the results by 'deployment_id' or 'status' query parameters.

Example: - /servers - /servers?deployment_id=web_app_v1 - /servers?status=free

Parameters:

  • ➖ compute_id 🔤 🚫
  • ➖ hostname 🔤 🚫
  • ➖ region 🔤 🚫
  • ➖ zone 🔤 🚫
  • ➖ cpu_count 🔢 🚫
  • ➖ deployment_id 🔤 🚫
  • ➖ status 🔤 🚫

Responses:

  • ✅ 200 → array[ComputeUnitResponse]

  • ❌ 422 → HTTPValidationError

🗂️ admin

🟩 POST /admin/init_server

Init Server

Request body (JSON): InitServerRequest

Responses:

  • ✅ 200 → {}

  • ❌ 422 → HTTPValidationError

🟥 DELETE /admin/decommission_server/{hostname}

Decommission Server

Parameters:

  • ❗ hostname 🔤

Responses:

  • ✅ 200 → {}

  • ❌ 422 → HTTPValidationError

🧱 Schemas

ComputeUnitRequest

Required:

  • ssh_public_key 🔤
  • tags 📦 🚫

Optional:

  • cpu_count 🔢 🚫 default: 4
  • region 🔤 🚫
  • zone 🔤 🚫

ComputeUnitResponse

Required:

  • started_at 🔤 🚫
  • ip 🔤
  • ports_range 🔤 🚫
  • cpu_range 🔤
  • tags 📦 🚫
  • compute_id 🔤
  • region 🔤
  • zone 🔤
  • cpu_list 🔤
  • hostname 🔤
  • status 🔤
  • cpu_count 🔢

HTTPValidationError

Optional:

  • detail array[ValidationError]

InitServerRequest

Required:

  • ip 🔤
  • region 🔤
  • zone 🔤
  • cpu_ranges array[🔤]
  • hostname 🔤

ValidationError

Required:

  • type 🔤
  • msg 🔤
  • loc array[🔤 🔢]