Pure Storage · Schema
SubscriptionLicense
SubscriptionLicense schema from Pure1 Public REST API
StorageData StorageFlash StorageEnterprise StorageCloud StorageObject StorageFile StorageBlock StorageKubernetes StorageInfrastructure
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SubscriptionLicense",
"description": "SubscriptionLicense schema from Pure1 Public REST API",
"$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-subscription-license-schema.json",
"allOf": [
{
"description": "A built-in resource. Many are singletons predefined by Purity (e.g., support\nsettings). Some correspond to a piece of software, like an app, or hardware,\nlike a controller. Others are created by the system in response to some event\n(e.g., alerts, audit records).\n\nTypically, a user can't create, delete or rename a built-in resource. A few\ncan be created or deleted, but not renamed because the names are meaningful\nto Purity (e.g., VIFs).\n\n",
"allOf": [
{
"$ref": "#/components/schemas/_timeAware"
},
{
"type": "object",
"properties": {
"id": {
"description": "A non-modifiable, globally unique ID chosen by the system.",
"type": "string",
"readOnly": true,
"example": "01c2889a-4124-49ff-8cbd-c33405ede123"
},
"name": {
"description": "A non-modifiable, locally unique name chosen by the system.",
"type": "string",
"readOnly": true,
"example": "example_name"
}
}
}
]
},
{
"description": "A license belonging to a Pure1 subscription.\n",
"type": "object",
"properties": {
"add_on_slas": {
"description": "Add-on SLAs.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionLicenseAddOnSla"
}
},
"average_on_demand": {
"description": "Estimated daily on-demand usage of the license from the current calendar\nquarter to date.\n",
"title": "Current_metric",
"allOf": [
{
"$ref": "#/components/schemas/_current_metric"
}
]
},
"expiration_date": {
"description": "Date when the license expires.\nRepresented as a timestamp of 00:00 on that date in UTC, in\nmilliseconds since UNIX epoch.\n",
"type": "integer",
"format": "int64",
"example": 1636238104000
},
"last_updated_date": {
"description": "The date of the last amendment to the current license.\nRepresented as a timestamp of 00:00 on that date in UTC, in\nmilliseconds since UNIX epoch.\n",
"type": "integer",
"format": "int64",
"example": 1604702243000
},
"marketplace_partner": {
"description": "Reference information about the marketplace partner of this license.\n",
"title": "Marketplace_partner",
"allOf": [
{
"$ref": "#/components/schemas/_marketplace_partner"
}
]
},
"pre_ratio": {
"description": "The pre-reduced & encrypted ratio calculated at license level.\n",
"allOf": [
{
"$ref": "#/components/schemas/_current_metric"
},
{
"type": "object",
"properties": {
"data": {
"type": "number",
"format": "float",
"example": 3.3
}
}
}
]
},
"quarter_on_demand": {
"description": "Estimated total on-demand usage of the license of the current calendar quarter to date.\n",
"title": "Current_metric",
"allOf": [
{
"$ref": "#/components/schemas/_current_metric"
}
]
},
"reservation": {
"description": "Current reservation amount of the license.\n",
"title": "Current_metric",
"allOf": [
{
"$ref": "#/components/schemas/_current_metric"
}
]
},
"resources": {
"description": "References to the resources that operate under this license.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/_license_resource_reference"
}
},
"service_tier": {
"description": "The tier of the service for the license.\n",
"type": "string",
"example": "//Block - Ultra"
},
"site_address": {
"description": "The license site address.",
"title": "Base_address",
"allOf": [
{
"$ref": "#/components/schemas/_base_address"
}
]
},
"start_date": {
"description": "Date when the license starts.\nRepresented as a timestamp of 00:00 on that date in UTC, in\nmilliseconds since UNIX epoch.\n",
"type": "integer",
"format": "int64",
"example": 1604702243000
},
"subscription": {
"description": "A reference to which subscription this license belongs.\n",
"title": "FixedReference",
"allOf": [
{
"$ref": "#/components/schemas/_fixedReference"
}
]
},
"usage": {
"description": "Usage of the license, averaged over the last day.\n",
"title": "Current_metric",
"allOf": [
{
"$ref": "#/components/schemas/_current_metric"
}
]
}
}
}
]
}