Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• name: required (string - maxLength: 50)

  Name of the given object.

  Examples:

  MyDataCenter

• type: required (one of datacenter, room, row, rack, device, group)

  Asset type. Possible values are datacenter, room, row, rack, device and group.

• sub_type: required (one of epdu, feed, genset, pdu, rack controller, router, server, storage, sts, switch, ups, vm, input_power, sensor, )

  In the case of type "device", the subtype has to be specified. Possible values are epdu, feed, genset, pdu, rack controller, router, server, storage, sts, switch, ups, vm and sensor. In the case of type "group", the subtype may be input_power. In other cases, it must be empty.

• status: required (one of active, nonactive, spare, retired)

  Current asset status. Possible values are active, nonactive, spare and retired.

• location: required (string - maxLength: 50)

  The name of the parent asset element. If the element is unlocated or it is a datacenter, the key must be present but empty.

• location_id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

• location_uri: (string)

  The URI address of the parent asset element.

• priority: required (one of P1, P2, P3, P4, P5)

  Priority of the asset. Value P1 means the highest priority, value P5 means the lowest priority.

• powers: (array of Asset)

  A list of direct power sources; only for devices. Can be empty.

  Items: Asset

• groups: (array of Asset)

  A list of groups the asset belons to. Can be empty. Every item contains name and identifier of the group.

  Items: Asset

• ips: (array of Limited_String)

  A list of IP addresses (represented by string).

• hostnames: (array of Limited_String)

  A list of hostnames (represented by string).

• macs: (array of Limited_String)

  A list of mac addresses (represented by string).

• fqdns: (array of Limited_String)

  A list of fqdn names (represented by string).

• id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

• power_devices_in_uri: (string)

  A relative URI address which is used to select all power devices powering (or being in) the requested asset. Currently: /api/v1/assets?in=&sub_type=epdu,pdu,feed,genset,ups.

• parents: (array of Asset_Item)

  List of parents sorted from nearest element.

  Items: Asset_Item

• computed: required (Computed | Empty_Object)

  For racks (only), there are three possible properties that may be specified in this list: freeusize, outlet.available and realpower.nominal. For other asset types, "computed" is an empty object.

• ext: (array of Ext_Attribute)

  An optional list of extended attributes, that the user is free to fill. Every element of this list must contain name of the attribute with its value, and whether this attribute is only for reading.

  Items: Ext_Attribute

Examples:

{
  "name": "MyServer",
  "type": "device",
  "sub_type": "server",
  "location": "",
  "status": "active",
  "priority": "P2",
  "parents": [],
  "computed": {},
  "ext": [
    {
      "company": "Eaton",
      "read_only": false
    },
    {
      "country": "France",
      "read_only": false
    }
  ]
}

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

HTTP status code 500

Internal server error.

Body

Media type: application/json

Type: object

• code: required (integer)
• condition: required (string)

Examples:

{
  "code": 42,
  "condition": "Internal error; problems with connection to database or database is in inconsistent state – see log for more detail."
}

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• : required (string)

  List of asset subtypes with items separated by comma. Possible item values of the list are epdu, feed, genset, pdu, rack controller, router, server, storage, sts, switch, ups, vm and sensor.

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

• datacenters: required (array of Asset)

  Items: Asset

Examples:

{
  "datacenters": [
    {
      "id": "1",
      "name": "DC1"
    },
    {
      "id": "10",
      "name": "DC-LAB"
    }
  ]
}

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

• rooms: required (array of Asset)

  Items: Asset

Examples:

{
  "rooms": [
    {
      "id": "2",
      "name": "ROOM1"
    }
  ]
}

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

• racks: required (array of Asset)

  Items: Asset

Examples:

{
  "racks": [
    {
      "id": "4",
      "name": "RACK1"
    },
    {
      "id": "21",
      "name": "RACK2-LAB"
    }
  ]
}

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

• rows: required (array of Asset)

  Items: Asset

Examples:

{
  "rows": [
    {
      "id": "3",
      "name": "ROW1"
    },
    {
      "id": "17",
      "name": "ROW4"
    },
    {
      "id": "18",
      "name": "ROW6"
    }
  ]
}

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

• groups: required (array of Asset)

  Items: Asset

Examples:

{
  "groups": [
    {
      "id": "9",
      "name": "group1"
    },
    {
      "id": "30",
      "name": "GROUP1-LAB"
    }
  ]
}

URI Parameters

• asset-id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

URI Parameters

• asset-id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• name: required (string - maxLength: 50)

  Name of the given object.

  Examples:

  MyDataCenter

• type: required (one of datacenter, room, row, rack, device, group)

  Asset type. Possible values are datacenter, room, row, rack, device and group.

• sub_type: required (one of epdu, feed, genset, pdu, rack controller, router, server, storage, sts, switch, ups, vm, input_power, sensor, )

  In the case of type "device", the subtype has to be specified. Possible values are epdu, feed, genset, pdu, rack controller, router, server, storage, sts, switch, ups, vm and sensor. In the case of type "group", the subtype may be input_power. In other cases, it must be empty.

• status: required (one of active, nonactive, spare, retired)

  Current asset status. Possible values are active, nonactive, spare and retired.

• location: required (string - maxLength: 50)

  The name of the parent asset element. If the element is unlocated or it is a datacenter, the key must be present but empty.

• location_id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

• location_uri: (string)

  The URI address of the parent asset element.

• priority: required (one of P1, P2, P3, P4, P5)

  Priority of the asset. Value P1 means the highest priority, value P5 means the lowest priority.

• powers: (array of Asset)

  A list of direct power sources; only for devices. Can be empty.

  Items: Asset

• groups: (array of Asset)

  A list of groups the asset belons to. Can be empty. Every item contains name and identifier of the group.

  Items: Asset

• ips: (array of Limited_String)

  A list of IP addresses (represented by string).

• hostnames: (array of Limited_String)

  A list of hostnames (represented by string).

• macs: (array of Limited_String)

  A list of mac addresses (represented by string).

• fqdns: (array of Limited_String)

  A list of fqdn names (represented by string).

• id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

• power_devices_in_uri: (string)

  A relative URI address which is used to select all power devices powering (or being in) the requested asset. Currently: /api/v1/assets?in=&sub_type=epdu,pdu,feed,genset,ups.

• parents: (array of Asset_Item)

  List of parents sorted from nearest element.

  Items: Asset_Item

• computed: required (Computed | Empty_Object)

  For racks (only), there are three possible properties that may be specified in this list: freeusize, outlet.available and realpower.nominal. For other asset types, "computed" is an empty object.

• ext: (array of Ext_Attribute)

  An optional list of extended attributes, that the user is free to fill. Every element of this list must contain name of the attribute with its value, and whether this attribute is only for reading.

  Items: Ext_Attribute

Examples:

{
  "name": "Rack12",
  "type": "rack",
  "sub_type": "",
  "location": "Row11",
  "status": "active",
  "priority": "P1",
  "parents": [],
  "computed": {},
  "ext": [
    {
      "air_input": "front",
      "read_only": false
    },
    {
      "u_size": "4",
      "read_only": false
    }
  ]
}

URI Parameters

• asset-id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

Annotations

• Authorization:

  {"profile":["administrator"]}

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• in: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• : required (string)

  List of asset identifiers with items separated by comma.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• : required (string)

  List of asset identifiers with items separated by comma.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• : required (string)

  List of asset identifiers with items separated by comma.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• start_ts: (string - pattern: ^[0-9]{14}Z$)

  Start of the requested interval in ISO 8601 format without hyphens and colons, i.e. YYYYMMDDThhmmssZ. Not required only if parameter "relative" is specified.

• end_ts: (string - pattern: ^[0-9]{14}Z$)

  End of the requested interval in ISO 8601 format without hyphens and colons, i.e. YYYYMMDDThhmmssZ. Not required only if parameter "relative" is specified.

• type: (one of arithmetic_mean, min, max)

  Type of the requested statistics. The value may be arithmetic_mean or min or max. If this parameter is not specified, arithmetic mean is returned.

• step: required (one of 15m, 30m, 1h, 8h, 24h, 7d, 30d)

  Granularity of the requested statistics. The value may be 15m (fifteen minutes), 30m (thirty minutes), 1h (one hour), 8h (eight hours) or 24h (twenty four hours).

• element_id: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the requested asset element.

• source: required (string)

  The name of the requested matric. Valid metric names for the given assets element can be found at /api/v1/metric/current.

• relative: (one of 24h, 7d, 30d, )

  This parameter overrides parameters "start_ts" and "end_ts". It sets parameter "end_ts" to current timestamp (i.e. now) and parameter "start_ts" to current timestamp minus the value of "relative" parameter. Possible values are 24h, 7d, 30d and "" (empty string).

  Value "" behaves as if the parameter "relative" was not specified at all. It is not necessary to specify parameters "start_ts" and "end_ts" when parameter "relative" is specified – specifying them, however, does not create a conflict.

• ordered: (one of true, false)

  This is optional parameter with possible values true and false. Default value is false. If this parameter is set to true, the returned data are ordered in ascending order.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• : required (string)

  List of asset identifiers with items separated by comma.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• state: required (one of ALL, ALL-ACTIVE, ACTIVE, ACK-WIP, ACK-IGNORE, ACK-PAUSE, ACK-SILENCE, RESOLVED)

  State of an alert. Possible values are ALL, ALL-ACTIVE, ACTIVE, ACK-WIP, ACK-IGNORE, ACK-PAUSE, ACK-SILENCE and RESOLVED. State RESOLVED can not be set manually – it is a result of conditions, that triggered an alert, coming back to normal values.

• asset: required (string - pattern: ^[0-9]{0,10}$)

  Identifier of the given asset.

• recursive: (one of true, false)

  This parameter is used to list alerts recursively for all asset elements that belong under the specified asset element in topology. Possible values are true and false; default value is false.

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: Threshold_Rule | Single_Rule | Pattern_Rule

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Query String

• type: (one of all, pattern, single, threshold)

  A type of the alert rules. Possible values are all, threshold, single, pattern. If the parameter is not specified, value equals to all.

• rule_class: (string)

  List the alert rules with the specified class only. The class is an opaque string and equals to the rule property "rule_class".

URI Parameters

• rule_name: required (string - pattern: ^[-_.A-Za-z0-9@]{1,255}$)

  Name of the given alert rule.

  Examples:

  onbypass@ROZ.UPS36

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

URI Parameters

• rule_name: required (string - pattern: ^[-_.A-Za-z0-9@]{1,255}$)

  Name of the given alert rule.

  Examples:

  onbypass@ROZ.UPS36

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: Threshold_Rule | Single_Rule | Pattern_Rule

Examples:

{
  "threshold": {
    "rule_name": "load.default@ROZ.UPS33",
    "rule_class": "Default load in UPS",
    "rule_hierarchy": "power.load.ups",
    "rule_desc": "Load percentage for ups ROZ.UPS33",
    "target": [
      "load.default@ROZ.UPS33"
    ],
    "element": "ROZ.UPS33",
    "values_unit": "%",
    "values": [
      {
        "low_critical": 20
      },
      {
        "low_warning": 30
      }
    ],
    "results": [
      {
        "low_critical": {
          "action": [
            "EMAIL",
            "SMS"
          ],
          "severity": "CRITICAL",
          "description": "Default load in ups is critically low."
        }
      },
      {
        "low_warning": {
          "action": [
            "EMAIL",
            "SMS"
          ],
          "severity": "WARNING",
          "description": "Default load in ups is low."
        }
      }
    ],
    "evaluation": "function main(f1, f2, f3) local avg = (f1 + f2 + f3) / 3; local deviation = math.max (math.abs (f1 - avg), math.abs (f2 - avg), math.abs (f3 - avg)); local percentage = deviation / avg * 100; if (percentage > high_critical) then return HIGH_CRITICAL end; if (percentage > high_warning) then return HIGH_WARNING end; return OK; end"
  }
}

URI Parameters

• rule_name: required (string - pattern: ^[-_.A-Za-z0-9@]{1,255}$)

  Name of the given alert rule.

  Examples:

  onbypass@ROZ.UPS36

• asset_name: required (string - maxLength: 50)

  Name of the given object.

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• state: required (one of ALL, ALL-ACTIVE, ACTIVE, ACK-WIP, ACK-IGNORE, ACK-PAUSE, ACK-SILENCE, RESOLVED)

  State of an alert. Possible values are ALL, ALL-ACTIVE, ACTIVE, ACK-WIP, ACK-IGNORE, ACK-PAUSE, ACK-SILENCE and RESOLVED. State RESOLVED can not be set manually – it is a result of conditions, that triggered an alert, coming back to normal values.

Examples:

{
  "state": "ACK-PAUSE"
}

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Body

Media type: application/json

Type: Time | NTP

Examples:

{
  "time": "2016-09-07T17:23:00Z"
}

{
  "ntp": "pool.ntp.org"
}

HTTP status code 200

Success.

Body

Media type: application/json

Type: object

• time: required (object)

  Date time typed in the format YYYY-MM-DDThh:mm:ssZ.

  • time: required (string - pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$)
• ntp: required (object)

  Network time protocol server – IP address or hostname.

  • ntp: required (string - pattern: ^[-._a-zA-Z0-9]*$)

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• config: required (object)

  An object with two properties: "key" (configuration setting name) and "value".

  • key: required (string - pattern: ^[.-_a-zA-Z0-9]+$)
  • value: required (string - pattern: ^[-._a-zA-Z0-9]*$)

    The value of the configuration setting given by "key".

Examples:

{
  "config": {
    "key": "smtp",
    "value": "1.3.2.4"
  }
}

Annotations

• Authorization:

  {"profile":["administrator"]}

Query String

• key: required (string - pattern: ^[.-_a-zA-Z0-9]+$)

URI Parameters

• service_name: required (string)

  Name of a system service.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• service_name: required (string - maxLength: 50)

  Name of the given object.

Examples:

{
  "service_name": "42ity-asset"
}

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• service_name: required (string - maxLength: 50)

  Name of the given object.

Examples:

{
  "service_name": "42ity-asset"
}

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• service_name: required (string - maxLength: 50)

  Name of the given object.

Examples:

{
  "service_name": "42ity-asset"
}

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• service_name: required (string - maxLength: 50)

  Name of the given object.

Examples:

{
  "service_name": "42ity-asset"
}

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• service_name: required (string - maxLength: 50)

  Name of the given object.

Examples:

{
  "service_name": "42ity-asset"
}

URI Parameters

• iface_name: required (string - pattern: ^[A-Za-z][A-Za-z0-9]{0,14}$)

  Interface name – has to fit specified regular expression.

Annotations

• Authorization:

  {"profile":["administrator"]}

URI Parameters

• iface_name: required (string - pattern: ^[A-Za-z][A-Za-z0-9]{0,14}$)

  Interface name – has to fit specified regular expression.

Annotations

• Authorization:

  {"profile":["administrator"]}

Body

Media type: application/json

Type: object

• /^[A-Za-z][A-Za-z0-9]{0,14}$/: required (object)

  Name of the given interface. The following properties are available:

  1. method
  2. address
  3. netmask
  4. gateway
  5. nameservers
  • method: (one of static, dhcp)

    A kind of the method by which an IP address is assigned. Value static means manually assigned address, and value dhcp means use of Dynamic Host Configuration Protocol.

  • address: (string - pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$)

    IP address; only IPv4 addresses are supported.

  • netmask: (string - pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$)

    The subnet mask of the IP address.

    Examples:

    255.255.255.0

  • gateway: (string - pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$)

    Default gateway.

  • nameservers: (array of items)

    Preferred DNS (Domain Name System) servers.

Examples:

{
  "LAN2": {
    "method": "static",
    "address": "192.168.1.10",
    "netmask": "255.255.255.0",
    "gateway": "192.168.1.1",
    "nameservers": [
      "192.168.127.1"
    ]
  }
}

URI Parameters

• iface_name: required (string - pattern: ^[A-Za-z][A-Za-z0-9]{0,14}$)

  Interface name – has to fit specified regular expression.

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Annotations

• Authorization:

  {"profile":["dashboard","administrator"]}

Body

Media type: application/json

Type: object

• user: required (string - maxLength: 50 - pattern: ^[-_A-Za-z0-9]{1,50}$)

  Valid user name.

• old_passwd: required (string - pattern: ^.{0,150}$)

  Old (valid) password of the concerned user.

• new_passwd: required (string - pattern: ^.{0,150}$)

  New (valid) password of the concerned user.

Annotations

• Authorization:

  {"profile":["anonymous","dashboard","administrator"]}

Query String

• detail: required (yes)

  There is only one possible value: yes. If the value is set to something else, the parameter is considered not specified.

Annotations

• Authorization:

  {"profile":["anonymous","dashboard","administrator"]}

Body

Media type: application/json

Type: object

• username: required (string - maxLength: 50 - pattern: ^[-_A-Za-z0-9]{1,50}$)

  Valid user name.

• password: required (string - pattern: ^.{0,150}$)

  (Valid) password of the concerned user.

• grant_type: required (password)

  Property "grant_type" has to be set to password.

Examples:

{
  "username": "admin",
  "password": "pwd?1234",
  "grant_type": "password"
}

Annotations

• Authorization:

  {"profile":["anonymous","dashboard","administrator"]}

Body

Media type: application/x-www-form-urlencoded

Type: object

• token: required (string - pattern: ^[-/._~+/a-zA-Z0-9]{0,255}={0,10}$)

  Access token.

Examples:

{
  "token": "jgWCdeM8Ik9GbSBCVLTk9K-oRqzR-7qt7SwZSekzORx_-uqLIKsUvIKL5w=="
}