Download OpenAPI specification:Download
This is a public API to demonstrate features of Xormon NG API
Authorization
API requests require authorization header with a valid Public API Key
You can create a Public API Key in Xormon NG UI or create a temporary Public API Key with /api/public/v1/auth
API.
Auth request
POST https://{host}/api/public/v1/auth
{
"username": "xormon",
"password": "xormon"
}
Response:
{
"statusCode":200,
"data": {
"apiKey":"3b766bcdb5e6afd1bdde2eaf13a5a5b0",
"expiration":"2023-07-26T07:43:53.763Z"
}
}
Public API Key in other requests
GET https://{host}/api/public/v1/architecture/classes
Header: 'apiKey: 3b766bcdb5e6afd1bdde2eaf13a5a5b0'
Generates API based on username and password
username required | string |
password required | string |
{- "username": "string",
- "password": "string"
}
{- "statusCode": 0,
- "message": "string",
- "error": "string",
- "data": {
- "apiKey": "string",
- "expiration": "string"
}
}
Returns a list of all classes that are needed for further filtering of hw_types
{- "data": [
- {
- "label": "string",
- "class": "string",
- "active": true
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of hw_types under the specified class, which are then needed for further subsystem filtering
class required | string |
list_models | boolean If true list hw_types with matching system models. |
{- "data": [
- {
- "hw_type": "string",
- "label": "string",
- "active": true,
- "allowed": true,
- "class": "string",
- "matching_models": [
- "string"
]
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of subsystems that are further needed for filtering items and metrics
class required | string |
hw_type required | string |
{- "data": [
- {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": { },
- "parents": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": { },
- "parents": [
- { }
]
}
]
}
]
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of metrics that are used to export timeseries data
class required | string |
hw_type required | string |
subsystem required | string |
{- "data": [
- {
- "metric": "string",
- "label": "string",
- "unit": "string"
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of items that are used to export timeseries data
class required | string |
hw_type required | string |
subsystem required | string |
{- "data": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": { },
- "parents": [
- { }
]
}
]
}, - "parents": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- { }
]
}, - "parents": [
- { }
]
}
]
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of properties that are used to export configuration data
class required | string |
hw_type required | string |
subsystem required | string |
{- "data": [
- {
- "property_name": "string",
- "label": "string"
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Searching for items based on parameters: hw_type, subsystem, label. The number of records returned and the page number can be defined.
subsystem | string |
hw_type | string |
class | string |
parents | string Example: parents=id1,id2,id3 Comma separated list of parent item ids |
search | string |
page | number Page indexing starts at 0 |
limit | number |
{- "data": {
- "metadata": {
- "start": 0,
- "end": 99,
- "max": 100,
- "page": 0,
- "info": "string"
}, - "items": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": { },
- "parents": [
- { }
]
}
]
}, - "parents": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- { }
]
}, - "parents": [
- { }
]
}
]
}
]
}, - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of all devices - root items. (Server at Powers, vCenter at VMware, Device at storages)
{- "data": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": { },
- "parents": [
- { }
]
}
]
}, - "parents": [
- {
- "item_id": "string",
- "label": "string",
- "hw_type": "string",
- "subsystem": "string",
- "subsystem_detail": {
- "subsystem": "string",
- "label": "string",
- "hw_type": "string",
- "class": "string",
- "items": [
- { }
]
}, - "parents": [
- { }
]
}
]
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
{- "data": [
- {
- "export_id": "string",
- "label": "string",
- "format": "csv",
- "type": "timeseries",
- "last_run": null,
- "created": null,
- "recurrence": {
- "freq": "string",
- "mail": "string",
- "month": [
- 0
], - "setpos": 0,
- "weekday": [
- "string"
], - "year_day": 0,
- "month_day": 0,
- "week_number": 0
}
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns data export based on set parameters
start required | number Time in UNIX millisecond format |
end required | number Time in UNIX millisecond format |
metric required | Array of strings |
uuids required | Array of strings |
format | string Default: "json" Enum: "csv" "json" "xlsx" |
{- "start": 0,
- "end": 0,
- "metric": [
- "string"
], - "uuids": [
- "string"
], - "format": "csv"
}
{- "statusCode": 0,
- "message": "string",
- "error": "string"
}
Exports the mapping for the given uuids
uuids required | Array of strings |
format | string Default: "json" Enum: "csv" "json" "xlsx" |
{- "uuids": [
- "string"
], - "format": "csv"
}
{- "statusCode": 0,
- "message": "string",
- "error": "string"
}
Exports the configuration for the given uuids of device, volume or host. Storage-only feature
uuids required | Array of strings |
properties | Array of strings List of properties to export. If left empty, all properties are exported |
format | string Default: "json" Enum: "csv" "json" "xlsx" |
{- "uuids": [
- "string"
], - "properties": [
- "string"
], - "format": "csv"
}
{- "statusCode": 0,
- "message": "string",
- "error": "string"
}
Exports the capacity for the given uuids. Storage-only feature
uuids required | Array of strings |
format | string Default: "json" Enum: "csv" "json" "xlsx" |
{- "uuids": [
- "string"
], - "format": "csv"
}
{- "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of all device (hostcfg) configurations
{- "data": [
- {
- "hostcfg_id": "string",
- "label": "string",
- "hw_type": "string",
- "disabled": true,
- "target": true,
- "ignore_health_status": true,
- "ignore_health_status_reason": "string",
- "data": { },
- "hw_type_label": "string",
- "limited": true
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Add a new device (host configuration)
label | string Custom name assigned to the device and displayed throughout the user interface. |
hw_type | string Device type or model. See Architecture APIs: List of all classes and List of hw_types for available values. |
disabled | boolean Device disabled for monitoring if set to "true". |
ignore_health_status | boolean Device health status is not reported. |
ignore_health_status_reason | string or null Reason for ignoring device health status. |
data | object Settings specific to the selected HW type. See "List host configuration data properties for specific technology" or "List host configuration data properties for specific device type" |
created_at | string <date-time> |
updated_at | string <date-time> |
{- "label": "string",
- "hw_type": "string",
- "disabled": true,
- "ignore_health_status": true,
- "ignore_health_status_reason": "string",
- "data": { },
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "data": {
- "hostcfg_id": "string",
- "label": "string",
- "hw_type": "string",
- "disabled": true,
- "target": true,
- "ignore_health_status": true,
- "ignore_health_status_reason": "string",
- "data": { },
- "hw_type_label": "string",
- "limited": true
}, - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns a list of all device data property keys, what types they are and if they are required or not. This information is used when creating new hostconfigurations.
{- "data": [
- {
- "exampleDataKey": {
- "type": "string",
- "required": true,
- "possibleValues": [
- "string"
], - "properties": { },
- "arrayItemType": "string",
- "arrayItemValues?": [ ],
- "arrayItemProperties": { }
}
}
], - "statusCode": 0,
- "message": "string",
- "error": "string"
}
Returns definition of specific technology configuration data properties.
hw_type required | string |
{- "data": {
- "exampleDataKey": {
- "type": "string",
- "required": true,
- "possibleValues": [
- "string"
], - "properties": { },
- "arrayItemType": "string",
- "arrayItemValues?": [ ],
- "arrayItemProperties": { }
}
}, - "statusCode": 0,
- "message": "string",
- "error": "string"
}
{- "statusCode": 0,
- "message": "string",
- "error": "string",
- "data": [
- {
- "status": "error",
- "count": 0,
- "devices": [
- {
- "class": "string",
- "hw_type": "string",
- "label": "string",
- "status": "string",
- "item_id": "string",
- "updatedAt": 0,
- "note": "string",
- "hw_type_label": "string",
- "ignored": true,
- "ignore_reason": "string",
- "url": "string"
}
]
}
]
}
Returns a list of health statuses by severity
severity required | string Enum: "error" "warning" "ok" Example: error |
{- "statusCode": 0,
- "message": "string",
- "error": "string",
- "data": [
- {
- "status": "error",
- "count": 0,
- "devices": [
- {
- "class": "string",
- "hw_type": "string",
- "label": "string",
- "status": "string",
- "item_id": "string",
- "updatedAt": 0,
- "note": "string",
- "hw_type_label": "string",
- "ignored": true,
- "ignore_reason": "string",
- "url": "string"
}
]
}
]
}