API Documentation

Integrate KorPro into your workflows with our comprehensive REST API. All endpoints require authentication via API key.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.korpro.io/v1
Efficiency data available via API: When the Inspector runs in Efficiency mode, the API surfaces rightsizing recommendations and idle workload scores alongside orphaned resource findings. Look for the efficiency field on cluster scan results.

Endpoints

List Clusters

GET /clusters

Returns a list of all discovered clusters.

{
  "clusters": [
    {
      "id": "cluster-123",
      "name": "prod-gke-1",
      "provider": "gcp",
      "region": "us-central1",
      "healthScore": 85,
      "efficiency": 78
    }
  ]
}

Get Cluster Details

GET /clusters/{clusterId}

Returns detailed information about a specific cluster.

Get Unused Resources

GET /clusters/{clusterId}/resources/unused

Returns a list of unused resources in the cluster.

Get Cost Analysis

GET /clusters/{clusterId}/cost

Returns cost analysis for unused resources.

Rate Limits

API requests are limited to 1000 requests per hour per API key. Rate limit headers are included in all responses.

Error Responses

All errors follow a consistent format:

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Cluster not found",
    "details": {}
  }
}