Xormon NG Public API (1.0.0)

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'

Auth

Public API Key generation

Generates API based on username and password

Request Body schema: application/json
required
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string",
  • "data": {
    }
}

Architecture

List of all classes

Returns a list of all classes that are needed for further filtering of hw_types

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List of hw_types

Returns a list of hw_types under the specified class, which are then needed for further subsystem filtering

Authorizations:
apiKey
path Parameters
class
required
string
query Parameters
list_models
boolean

If true list hw_types with matching system models.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List of subsystems

Returns a list of subsystems that are further needed for filtering items and metrics

Authorizations:
apiKey
path Parameters
class
required
string
hw_type
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List of metrics

Returns a list of metrics that are used to export timeseries data

Authorizations:
apiKey
path Parameters
class
required
string
hw_type
required
string
subsystem
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List of items

Returns a list of items that are used to export timeseries data

Authorizations:
apiKey
path Parameters
class
required
string
hw_type
required
string
subsystem
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List of properties

Returns a list of properties that are used to export configuration data

Authorizations:
apiKey
path Parameters
class
required
string
hw_type
required
string
subsystem
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List of all devices (root level items)

Returns a list of all devices - root items. (Server at Powers, vCenter at VMware, Device at storages)

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Exporter

List of exports

Returns a list of exports created from the GUI

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Export

Returns the export result

Authorizations:
apiKey
path Parameters
export_id
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Export data

Returns data export based on set parameters

Authorizations:
apiKey
Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0,
  • "metric": [
    ],
  • "uuids": [
    ],
  • "format": "csv"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Export mapping

Exports the mapping for the given uuids

Authorizations:
apiKey
Request Body schema: application/json
required
uuids
required
Array of strings
format
string
Default: "json"
Enum: "csv" "json" "xlsx"

Responses

Request samples

Content type
application/json
{
  • "uuids": [
    ],
  • "format": "csv"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Export configuration

Exports the configuration for the given uuids of device, volume or host. Storage-only feature

Authorizations:
apiKey
Request Body schema: application/json
required
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"

Responses

Request samples

Content type
application/json
{
  • "uuids": [
    ],
  • "properties": [
    ],
  • "format": "csv"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Export capacity

Exports the capacity for the given uuids. Storage-only feature

Authorizations:
apiKey
Request Body schema: application/json
required
uuids
required
Array of strings
format
string
Default: "json"
Enum: "csv" "json" "xlsx"

Responses

Request samples

Content type
application/json
{
  • "uuids": [
    ],
  • "format": "csv"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Device configuration

List all host configurations

Returns a list of all device (hostcfg) configurations

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Add host configurations

Add a new device (host configuration)

Authorizations:
apiKey
Request Body schema: application/json
required
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>

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Delete host configurations

Add a new device (host configuration)

Authorizations:
apiKey
path Parameters
hostcfg_id
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List all host configurations data types

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.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

List host configuration data properties for specific technology.

Returns definition of specific technology configuration data properties.

Authorizations:
apiKey
path Parameters
hw_type
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Health Status

Health status

Returns a list of health statuses

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string",
  • "data": [
    ]
}

Health status by severity

Returns a list of health statuses by severity

Authorizations:
apiKey
path Parameters
severity
required
string
Enum: "error" "warning" "ok"
Example: error

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string",
  • "data": [
    ]
}