License API endpoints
Use the License API endpoints to track the license usage of BMC Helix Continuous Optimization. Before you run an endpoint, make sure that you authenticate the API request.
{
"openapi": "3.0.2",
"paths": {
"/opt/api/v1/supervisorcore/license": {
"get": {
"summary": "License Report",
"description": "Return license details",
"operationId": "license",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"co": {
"AUDIT_COUNT": 0,
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Overall average number of managed servers",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Servers",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
},
"co-distinct-name": {
"AUDIT_COUNT": "0",
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Overall average number of managed servers - distinct by name",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Servers",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
},
"coee": {
"AUDIT_COUNT": "0",
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Average number of managed servers imported from Capacity Agents",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Servers [Capacity Agents]",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
},
"coee-distinct-name": {
"AUDIT_COUNT": "0",
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Average number of managed servers imported from Capacity Agents - distinct by name",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Servers [Capacity Agents]",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
},
"serverless": {
"AUDIT_COUNT": "0",
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Average number of Serverless Assets",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Serverless Assets",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
},
"network": {
"AUDIT_COUNT": "0",
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Overall average number of managed network devices",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Network",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
},
"storage": {
"AUDIT_COUNT": "0",
"HOST": "Helix",
"LICENSE_DESCRIPTION": "Overall average number of managed ports",
"LICENSE_REQUESTED_FROM": "1585692000000",
"LICENSE_REQUESTED_TO": "1618876800000",
"LICENSE_TYPE": "20",
"PRODUCT_NAME": "Helix Continuous Optimization for Storage",
"PRODUCT_VERSION": "21.02",
"REPORT_DATE": "1618909773569",
"SUITE_NAME": "Helix Optimize"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/monthly": {
"get": {
"summary": "Monthly licenses counts",
"description": "Summary information on SKUs by month. Can be filtered with 'from' and 'to' params",
"operationId": "monthlyReport",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonthlyReport"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/luku": {
"get": {
"summary": "License Report",
"description": "Return license details",
"operationId": "licenseLuku",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": " AuditCount 0 Host Not used in Helix LicenseChecksum 1842100302 LicenseDescription Overall average number of managed servers LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Servers ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize AuditCount 0 Host Not used in Helix LicenseChecksum 62101739 LicenseDescription Overall average number of managed servers - distinct by name LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Servers ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize AuditCount 0 Host Not used in Helix LicenseChecksum 595745328 LicenseDescription Average number of managed servers imported from Capacity Agents LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Servers [Capacity Agents] ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize AuditCount 0 Host Not used in Helix LicenseChecksum 689579675 LicenseDescription Average number of managed servers imported from Capacity Agents - distinct by name LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Servers [Capacity Agents] ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize AuditCount 0 Host Not used in Helix LicenseChecksum 306918437 LicenseDescription Average number of Serverless Assets LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Serverless Assets ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize AuditCount 0 Host Not used in Helix LicenseChecksum 2037448438 LicenseDescription Overall average number of managed network devices LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Network ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize AuditCount 0 Host Not used in Helix LicenseChecksum 1586888632 LicenseDescription Overall average number of managed ports LicenseRequestedFrom 1585692000000 LicenseRequestedTo 1618876800000 LicenseType 20 ProductName Helix Continuous Optimization for Storage ProductVersion 21.02 ReportDate 1618907821404 SuiteName Helix Optimize "
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/servers/details": {
"get": {
"summary": "Servers information details",
"description": "Return server information",
"operationId": "serversDetails",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "scroll",
"description": "use scroll to fetch data",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "scroll_id",
"description": "identifier for given opened scroll (to be used with 'scroll' parameter)",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsResponse"
},
"example": {
"systems": [
{
"entity_id": 2343,
"name": "Host 123",
"type_id": "sys:gen",
"type_name": "Generic",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
},
{
"entity_id": 4563,
"name": "Host 456",
"type_id": "sys:vh:vmw",
"type_name": "Virtual Host - VMware",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/servers/bytype": {
"get": {
"summary": "Numbers of server by type",
"description": "Summary information on servers grouped by type",
"operationId": "serversByType",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsTypeResponse"
},
"example": {
"systems": [
{
"type_id": "sys:gen",
"type_name": "Generic",
"count": 100,
"distinct_by_name_count": 90
},
{
"type_id": "sys:db",
"type_name": "Database Server",
"count": 4,
"distinct_by_name_count": 4
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/servers/daily": {
"get": {
"summary": "Daily count of servers",
"description": "Summary information on servers by day. Can be filtered with 'from' and 'to' params",
"operationId": "serversByDay",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByDayResponse"
},
"example": [
{
"ts": "2020-07-25T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-07-26T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-07-27T00:00:00Z",
"count": 102,
"distinct_by_name_count": 100
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/servers/monthly": {
"get": {
"summary": "Monthly count of servers",
"description": "Summary information on servers by month. Can be filtered with 'from' and 'to' params",
"operationId": "serversByMonth",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByMonthResponse"
},
"example": [
{
"ts": "2020-07-01T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-08-01T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-09-01T00:00:00Z",
"count": 102,
"distinct_by_name_count": 100
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/network/details": {
"get": {
"summary": "Network information details",
"description": "Return network information",
"operationId": "networkDetails",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsResponse"
},
"example": {
"systems": [
{
"entity_id": 2343,
"name": "Host 123",
"type_id": "sys:net:dev",
"type_name": "Network - Device",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
},
{
"entity_id": 4563,
"name": "Host 456",
"type_id": "sys:net:dev",
"type_name": "Network - Device",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/network/daily": {
"get": {
"summary": "Daily count of network systems",
"description": "Summary information on network systems by day. Can be filtered with 'from' and 'to' params",
"operationId": "networkByDay",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByDayResponse"
},
"example": [
{
"ts": "2020-07-25T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-07-26T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-07-27T00:00:00Z",
"count": 102,
"distinct_by_name_count": 100
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/network/monthly": {
"get": {
"summary": "Monthly count of network systems",
"description": "Summary information on network systems by month. Can be filtered with 'from' and 'to' params",
"operationId": "networkByMonth",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByMonthResponse"
},
"example": [
{
"ts": "2020-07-01T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-08-01T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-09-01T00:00:00Z",
"count": 102,
"distinct_by_name_count": 100
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/storage/details": {
"get": {
"summary": "Storage informations details",
"description": "Return storage informations",
"operationId": "storageDetails",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorageResponse"
},
"example": {
"systems": [
{
"entity_id": 2343,
"name": "Aus_Gen_vSAN_Cluster_01",
"type_id": "sys:ds",
"type_name": "Datastore",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
},
{
"entity_id": 4563,
"name": "Aus_Gen_vSAN_Cluster_02",
"type_id": "sys:ds",
"type_name": "Datastore",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/storage/daily": {
"get": {
"summary": "Daily count of storage systems",
"description": "Summary information on storage systems by day. Can be filtered with 'from' and 'to' params",
"operationId": "storageByDay",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByDayResponse"
},
"example": [
{
"ts": "2020-07-25T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-07-26T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-07-27T00:00:00Z",
"count": 102,
"distinct_by_name_count": 100
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/storage/monthly": {
"get": {
"summary": "Monthly count of storage systems",
"description": "Summary information on storage systems by month. Can be filtered with 'from' and 'to' params",
"operationId": "storageByMonth",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByMonthResponse"
},
"example": [
{
"ts": "2020-07-01T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-08-01T00:00:00Z",
"count": 100,
"distinct_by_name_count": 98
},
{
"ts": "2020-09-01T00:00:00Z",
"count": 102,
"distinct_by_name_count": 100
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/serverless/details": {
"get": {
"summary": "Serverless information details",
"description": "Return serverless information",
"operationId": "serverlessDetails",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerlessResponse"
},
"example": {
"systems": [
{
"entity_id": 2343,
"name": "AWS Cloud",
"type_id": "sys:cl:aws",
"type_name": "Cloud",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
},
{
"entity_id": 4563,
"name": "accounting-plus",
"type_id": "sys:kubernetes:pod",
"type_name": "Kubernetes - Pod",
"insert_ts": "2020-01-01T00:00:00Z",
"last_activity": "2020-01-15T00:00:00Z",
"status_id": 1
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/serverless/bytype": {
"get": {
"summary": "Numbers of serverless systems by type",
"description": "Summary information on serverless systems grouped by type",
"operationId": "serverlessByType",
"tags": [
"License"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsTypeResponse"
},
"example": {
"systems": [
{
"type_id": "sys:cl:aws",
"type_name": "Cloud",
"count": 100
},
{
"type_id": "sys:kubernetes:pod",
"type_name": "Kubernetes - Pod",
"count": 4
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/serverless/daily": {
"get": {
"summary": "Daily count of serverless systems",
"description": "Summary information on serverless systems by day. Can be filtered with 'from' and 'to' params",
"operationId": "serverlessByDay",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByDayResponse"
},
"example": [
{
"ts": "2020-07-25T00:00:00Z",
"count": 100
},
{
"ts": "2020-07-26T00:00:00Z",
"count": 100
},
{
"ts": "2020-07-27T00:00:00Z",
"count": 102
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
},
"/opt/api/v1/supervisorcore/license/serverless/monthly": {
"get": {
"summary": "Monthly count of serverless systems",
"description": "Summary information on serverless systems by month. Can be filtered with 'from' and 'to' params",
"operationId": "serverlessByMonth",
"tags": [
"License"
],
"parameters": [
{
"in": "query",
"name": "from",
"description": "start day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-25T00:00:00Z"
}
},
{
"in": "query",
"name": "to",
"description": "end day to include. Will be used to extract the month",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2020-07-27T00:00:00Z"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemsByMonthResponse"
},
"example": [
{
"ts": "2020-07-01T00:00:00Z",
"count": 100
},
{
"ts": "2020-08-01T00:00:00Z",
"count": 100
},
{
"ts": "2020-09-01T00:00:00Z",
"count": 102
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
}
}
},
"components": {
"schemas": {
"SKUEntry": {
"title": "SKU entry",
"description": "SKU entry",
"type": "object",
"required": [
"sku",
"count"
],
"properties": {
"sku": {
"type": "string",
"example": "BMC Helix Continuous Optimization for Servers"
},
"count": {
"type": "integer",
"format": "int32",
"example": 100
},
"distinct_by_name_count": {
"description": "Distinct by name can be useful since a server can be imported by more than one ETL",
"type": "integer",
"format": "int32",
"example": 90
}
}
},
"MonthAggregatedCount": {
"title": "Month aggregated count",
"description": "Aggregated count for SKUs of given month",
"type": "object",
"required": [
"ts",
"skus"
],
"properties": {
"ts": {
"type": "string"
},
"skus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SKUEntry"
}
}
}
},
"MonthlyReport": {
"title": "Monthly SKUs report",
"description": "Monthly SKUs report",
"type": "object",
"properties": {
"months": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonthAggregatedCount"
}
}
}
},
"SystemDetail": {
"title": "Server Details",
"description": "Information about server",
"type": "object",
"properties": {
"entity_id": {
"type": "number",
"example": 2343
},
"name": {
"type": "string",
"example": "Host 123"
},
"type_id": {
"type": "string",
"example": "sys:gen"
},
"type_name": {
"type": "string",
"example": "Generic"
},
"insert_ts": {
"type": "string",
"format": "date-time",
"example": "2019-01-28T00:00:00Z"
},
"last_activity": {
"type": "string",
"format": "date-time",
"example": "2019-01-28T00:00:00Z"
},
"status_id": {
"type": "number",
"example": 1
}
}
},
"SystemsResponse": {
"title": "Servers response",
"description": "Information about servers",
"type": "object",
"properties": {
"scroll_id": {
"type": "string"
},
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemDetail"
}
}
}
},
"SystemTypesCount": {
"title": "System count",
"description": "Count of system by type",
"type": "object",
"properties": {
"type_id": {
"type": "string",
"example": "sys:gen"
},
"type_name": {
"type": "string",
"example": "Generic"
},
"count": {
"type": "integer",
"format": "int32",
"example": 100
},
"distinct_by_name_count": {
"description": "Distinct by name can be useful since a server can be imported by more than one ETL",
"type": "integer",
"format": "int32",
"example": 90
}
}
},
"SystemsTypeResponse": {
"title": "Servers by type",
"description": "Count servers by type",
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemTypesCount"
}
}
}
},
"SystemsAggregatedCount": {
"title": "Servers aggregated count",
"description": "Count of server aggregated by day or monthly (depends on the endpoint)",
"type": "object",
"required": [
"ts",
"count"
],
"properties": {
"ts": {
"type": "string",
"format": "date-time",
"example": "2021-01-28T00:00:00Z"
},
"count": {
"type": "integer",
"format": "int32",
"example": 100
},
"distinct_by_name_count": {
"description": "Distinct by name can be useful since a server can be imported by more than one ETL",
"type": "integer",
"format": "int32",
"example": 90
}
}
},
"SystemsByDayResponse": {
"title": "Servers by day",
"description": "Count servers by day",
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemsAggregatedCount"
}
}
}
},
"SystemsByMonthResponse": {
"title": "Servers by month",
"description": "Count servers by month",
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemsAggregatedCount"
}
}
}
},
"StorageDetail": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemDetail"
},
{
"type": "object",
"properties": {
"storage_ports": {
"type": "number",
"example": 3
}
}
}
]
},
"StorageResponse": {
"title": "Servers response",
"description": "Informations about servers",
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StorageDetail"
}
}
}
},
"ServerlessDetail": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SystemDetail"
},
{
"type": "object",
"properties": {
"instances": {
"type": "number",
"example": 3
}
}
}
]
},
"ServerlessResponse": {
"title": "Servers response",
"description": "Information about servers",
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServerlessDetail"
}
}
}
},
"ApiError": {
"title": "ApiError",
"description": "An error message returned by the server",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"transient": {
"type": "boolean"
}
}
}
},
"responses": {
"BadRequest": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"NotFound": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"InternalServerError": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
},
"security": [
{
"BearerAuth": []
}
]
}