Skip to main content
GET
/
subscriptions
/
{platformType}
/
{subscriptionRef}
Get subscription results (on-demand)
curl --request GET \
  --url https://{host}/subscriptions/{platformType}/{subscriptionRef}
{
  "subscription": {
    "name": "Sample Subscription",
    "description": "A subscription for testing",
    "created": "Mon Jan 19 13:52:31 EST 2020",
    "createdBy": "saas",
    "updated": "Mon Jan 20 14:32:38 EST 2020",
    "updatedBy": "SaaSadmin",
    "lastRefreshed": "Mon Jan 20 01:32:59 EST 2020",
    "owner": "saas"
  },
  "count": 452,
  "results": [
    {
      "currentType": "standard_d2",
      "name": "st01-prepro-edge-307",
      "recommendationType": "Modernize - Optimal Family",
      "savingsEstimate": "43.850475",
      "serviceType": "Virtual Machine",
      "divider": "------------------------",
      "Availability Zone": "eastus+group"
    }
  ]
}

Path Parameters

​
platformType
enum<string>
required

Technology platform for the subscription results.

Available options:
cloud,
containers
​
subscriptionRef
string
required

Unique subscription identifier.

Query Parameters

​
divider
enum<string>
default:true

Display divider between properties and tags in each result: "true" (default) shows "divider": "------------------------", "false" hides it.

Available options:
true,
false
​
limit
integer
default:3000

Maximum number of results to return. Default 3000; valid range 1–30000. Only applies to on-demand queries (no limit for scheduled webhook pushes).

Required range: 1 <= x <= 30000

Response

Subscription results

​
subscription
object
required
​
count
integer
required

Number of recommendations in results.

​
results
object[]
required