Skip to main content
GET
/
systems
/
{id}
/
analysis-details
Get a system's instance type details
curl --request GET \
  --url https://{host}/systems/{id}/analysis-details \
  --header 'Authorization: Bearer <token>'
[
  {
    "current": {
      "entityId": "076e70cf-cff2-3cc6-8a4c-54200241de7c",
      "displayName": "testsystem",
      "resourceId": "9a0546d2-f4e1-46f0-bc09-a7422a6b72927",
      "azureId": "/subscriptions/cc377154-9605-4cb0-8b41-1b39e1c/resourcegroups/testsystem/providers/microsoft.compute/virtualmachines/testsystem",
      "resourceGroup": "testsystem",
      "instanceType": "Standard_DS1_v2",
      "blendedScore": 90,
      "compatibility": "Outside Spend Tolerance",
      "cpuModel": "Intel Xeon E5-2673 v3",
      "numCpus": 1,
      "memory": 3.5,
      "generation": 2,
      "catalogCost": 53.29,
      "predictedUptime": 84.51,
      "percentOptimalCost": 7.0210805
    },
    "optimal": {
      "instanceType": "Standard_B1s",
      "blendedScore": 99,
      "compatibility": "OK",
      "recommendationType": "Downsize - Optimal Family",
      "cpuModel": "Intel Haswell E5-2673 v3",
      "numCpus": 1,
      "memory": 1,
      "generation": 4,
      "catalogCost": 7.59,
      "effortEstimate": "Low"
    },
    "targets": [
      {
        "instanceType": "Standard_B1s",
        "cpuModel": "Intel Haswell E5-2673 v3",
        "numCpus": 1,
        "memory": 1,
        "generation": 4,
        "catalogCost": 7.59,
        "blendedScore": 99,
        "compatibility": "OK",
        "percentOptimalCost": 1,
        "effortEstimate": "Low"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique entity ID of the instance to analyze

Query Parameters

​
target
string
required

Target set to return.

  • all_instances: include all targets
  • compatible_instances: only targets with compatibility OK
  • incompatible_instances: only targets with compatibility != OK
  • optimal_instance: only the optimal instance (no targets array)
  • <instanceType>: a specific instance type name (e.g., m6i.large)
​
spendTolerance
number

Decimal multiplier threshold above which a target is considered outside spend tolerance. Example: 1.2 ⇒ allow up to 20% higher cost than current. Affects the compatibility value but does not limit the count returned under targets.

​
effortTolerance
enum<string>

Maximum acceptable implementation effort for a target to be considered compatible. Values (in increasing permissiveness): very_low, low, moderate, high. Affects the compatibility value but does not limit the count returned under targets.

Available options:
very_low,
low,
moderate,
high

Response

Analysis details for the requested system

A list of result envelopes (one per supplied entity ID)

​
current
object
required

Instance characteristics and analysis classification

​
optimal
object
required

Instance characteristics and analysis classification

​
targets
object[]

Additional instance options based on query inputs (may be omitted for optimal_instance)

​
message
string

Informational message returned with the status

​
status
enum<integer>

HTTP-like status code for this entity’s analysis

Available options:
200,
400,
401,
404,
500