Jump to

• Request
• Response

Create a Metric Instance

post

/api/metric/Instances

Creates a metric instance.
The minimum required properties in the request body are:

• InstanceName
• InstanceTypeID

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeviceName: string
  Serialized device name. It can be the device name with the zone appended to the end or just the device name

  Example: router.example.com;z1 OR router.example.com
• DeviceZoneName: string
  The name of the device zone if it is not included in the device name. Deprecated. Use serialized device name instead.

  Example: Default First Zone
• InstanceName: string
  The metric instance name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Example_Instance
• InstanceTypeID: integer
  Instance Type ID

  Example: 2

{
    "properties":{
        "DeviceName":{
            "description":"Serialized device name. It can be the device name with the zone appended to the end or just the device name",
            "type":"string",
            "example":"router.example.com;z1 OR router.example.com"
        },
        "DeviceZoneName":{
            "description":"The name of the device zone if it is not included in the device name. <em>Deprecated</em>. Use serialized device name instead.",
            "type":"string",
            "example":"Default First Zone"
        },
        "InstanceName":{
            "description":"The metric instance name.\n <br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Example_Instance"
        },
        "InstanceTypeID":{
            "description":"Instance Type ID",
            "type":"integer",
            "example":"2"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricInstancesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricInstancesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricInstancesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricInstancesRead"
    }
}

Nested Schema : metricInstancesRead

Type: object

Show Source

• DeviceID: integer
  Device ID

  Example: 1281
• DeviceName: string
  Device Name

  Example: router.example.com
• DeviceZoneName: string
  Device Zone Name

  Example: Default First Zone
• InstanceID: integer
  Instance ID

  Example: 235035
• InstanceName: string
  Instance Name

  Example: Example_Instance
• InstanceType: string
  Instance Type

  Example: SNMP Custom
• InstanceTypeID: integer
  Instance Type ID

  Example: 2

{
    "properties":{
        "InstanceID":{
            "description":"Instance ID",
            "type":"integer",
            "example":"235035"
        },
        "InstanceName":{
            "description":"Instance Name",
            "type":"string",
            "example":"Example_Instance"
        },
        "InstanceTypeID":{
            "description":"Instance Type ID",
            "type":"integer",
            "example":"2"
        },
        "InstanceType":{
            "description":"Instance Type",
            "type":"string",
            "example":"SNMP Custom"
        },
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"1281"
        },
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceZoneName":{
            "description":"Device Zone Name",
            "type":"string",
            "example":"Default First Zone"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top