Retrieve detailed per-instance-type machine stats for a site

curl -G https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/machine/instance-type/stats \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d siteId=siteId

[
  {
    "id": "d4f5a9b2-3c7e-4f1a-9b8d-2e5f7a1c9b3d",
    "name": "m5.large",
    "assignedMachineStats": {
      "total": 50,
      "initializing": 3,
      "ready": 20,
      "inUse": 22,
      "error": 2,
      "maintenance": 2,
      "unknown": 1
    },
    "allocated": 44,
    "maxAllocatable": 6,
    "usedMachineStats": {
      "total": 44,
      "initializing": 0,
      "ready": 0,
      "inUse": 42,
      "error": 1,
      "maintenance": 1,
      "unknown": 0
    },
    "tenants": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Tenant Alpha",
        "allocated": 25,
        "usedMachineStats": {
          "total": 25,
          "initializing": 0,
          "ready": 0,
          "inUse": 24,
          "error": 1,
          "maintenance": 0,
          "unknown": 0
        },
        "maxAllocatable": 0,
        "allocations": [
          {
            "id": "11111111-2222-3333-4444-555555555555",
            "name": "Web Servers",
            "total": 15
          },
          {
            "id": "66666666-7777-8888-9999-000000000000",
            "name": "Database Servers",
            "total": 10
          }
        ]
      },
      {
        "id": "f0e1d2c3-b4a5-6789-0abc-def123456789",
        "name": "Tenant Beta",
        "allocated": 19,
        "usedMachineStats": {
          "total": 19,
          "initializing": 0,
          "ready": 0,
          "inUse": 18,
          "error": 0,
          "maintenance": 1,
          "unknown": 0
        },
        "maxAllocatable": 0,
        "allocations": [
          {
            "id": "22222222-3333-4444-5555-666666666666",
            "name": "Analytics Cluster",
            "total": 19
          }
        ]
      }
    ]
  }
]

Returns machine stats for each instance type including allocation details and tenant breakdown.

User must have FORGE_PROVIDER_ADMIN authorization role. The specified site must belong to the Provider.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site

Response

idstringformat: "uuid"

Unique identifier for the InstanceType

namestring

Name of the InstanceType

assignedMachineStatsobject

Machine counts broken down by status

allocatedinteger

Number of Machines of this Instance Type allocated to Tenants

maxAllocatableinteger

Number of Ready Machines of this Instance Type available for additional allocation to Tenants

usedMachineStatsobject

Machine counts broken down by status

tenantslist of objects

Errors

403

Forbidden Error