Skip to main content

Resources

API docs by Redocly

Cloud license management: Resources (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with cloud license data.

KPIs

Get BYOL KPIs

Returns a collection of the KPIs for BYOL eligible licenses.

Authorizations:
bearerAuth
query Parameters
filter
string

Filter the KPI results. Format of the query string parameter: 

?filter=<filter name> <operator> <value>
Filter name Description Data type Example
resourceType The type of the resource String ?filter=resourceType -in ["SqlDatabase"]
appFamily The VM resource's application family String ?filter=appFamily -eq 'Windows Server'
For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "resources": {
    },
  • "estimatedSavings": {
    },
  • "licenses": {
    }
}

Resources

Get cloud resources

Returns a collection of cloud resources.

Authorizations:
bearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string

Filter the collection of Azure resources. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example
licenseStatus The status of the resource's license String ?filter=licenseStatus -eq 'Eligible'
imageSku The SKU for the resource's image String ?filter=imageSku -ne 'win10-21h2-pro-g2'
name The name of the resource String ?filter=name -contains 'RM-ALEDUB'
resourceGroup The resource group that contains the resource String ?filter=resourceGroup -in ["snowdemo", "dev-mgmt-rg"]
resourceType The type of the resource String ?filter=resourceType -in ["SqlVirtualMachine"]
subscriptionName The friendly name of the subscription associated with the resource String ?filter=subscriptionName-contains 'Platform Operations'
operatingSystem The operating system name for the resource String ?filter=operatingSystem -ne 'win10-21h2-pro-g2'
appFamily The VM resource's application family String ?filter=appFamily -eq 'Windows Server'

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}