DOCS/Technical Docs/API Reference/API Endpoints

API Endpoints

Complete reference for all available API endpoints.

Racks

List Racks

Retrieve all racks in your account.

http

Response:

json

Get Rack Details

Retrieve detailed information about a specific rack.

http

Response:

json

Workloads

Deploy Workload

Deploy a new workload to a rack.

http

Request Body:

json

Response:

json

List Workloads

List all workloads in your account.

http

Query Parameters:

  • rack_id (optional) - Filter by rack ID
  • status (optional) - Filter by status (RUNNING, STOPPED, ERROR)

Response:

json

Get Workload Details

Retrieve detailed information about a workload.

http

Response:

json

Scale Workload

Scale a workload to a different replica count.

http

Request Body:

json

Response:

json

Delete Workload

Delete a workload.

http

Response: 204 No Content

Monitoring

Get Rack Metrics

Retrieve real-time metrics for a rack.

http

Query Parameters:

  • start (optional) - Start timestamp (ISO 8601)
  • end (optional) - End timestamp (ISO 8601)
  • granularity (optional) - Data granularity (1m, 5m, 1h)

Response:

json

Get Workload Logs

Retrieve logs for a workload.

http

Query Parameters:

  • lines (optional) - Number of lines to retrieve (default: 100)
  • follow (optional) - Follow log stream (true/false)

Response:

json