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
  The serialized device name. It can be the device name with the zone appended to the end or just the device name.
  If you include the zone here, do not specify the DeviceZoneName or DeviceZoneID parameters.

  Example: router.example.com;z1 OR router.example.com
• DeviceZoneID: string
  The zone ID of the device associated with the metric instance. Used in combination with DeviceZoneName. Do not specify this if you used a serialized device name in DeviceName.

  Example: 1
• DeviceZoneName: string
  The name of the device zone, if it is not appended to DeviceName. Deprecated. Use a 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":"The serialized device name. It can be the device name with the zone appended to the end or just the device name.<br>\nIf you include the zone here, do not specify the DeviceZoneName or DeviceZoneID parameters.",
            "type":"string",
            "example":"router.example.com;z1 OR router.example.com"
        },
        "DeviceZoneName":{
            "description":"The name of the device zone, if it is not appended to DeviceName. <em>Deprecated</em>. Use a serialized device name instead.",
            "type":"string",
            "example":"Default First Zone"
        },
        "DeviceZoneID":{
            "description":"The zone ID of the device associated with the metric instance. Used in combination with DeviceZoneName. Do not specify this if you used a serialized device name in DeviceName.",
            "type":"string",
            "example":"1"
        },
        "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
  The ID of the device associated with the metric instance.

  Example: 1281
• DeviceName: string
  The name of the device associated with the metric instance.

  Example: router.example.com
• DeviceZoneID: string
  The zone ID of the device associated with the metric instance.

  Example: 1
• DeviceZoneName: string
  The zone name of the device associated with the metric instance.

  Example: Default First Zone
• InstanceID: integer
  The metric instance ID.

  Example: 235035
• InstanceName: string
  The metric instance name.

  Example: Example_Instance
• InstanceType: string
  The metric instance type.

  Example: SNMP Custom
• InstanceTypeID: integer
  The ID of the metric instance type.

  Example: 2

{
    "properties":{
        "InstanceID":{
            "description":"The metric instance ID.",
            "type":"integer",
            "example":"235035"
        },
        "InstanceName":{
            "description":"The metric instance name.",
            "type":"string",
            "example":"Example_Instance"
        },
        "InstanceTypeID":{
            "description":"The ID of the metric instance type.",
            "type":"integer",
            "example":"2"
        },
        "InstanceType":{
            "description":"The metric instance type.",
            "type":"string",
            "example":"SNMP Custom"
        },
        "DeviceID":{
            "description":"The ID of the device associated with the metric instance.",
            "type":"integer",
            "example":"1281"
        },
        "DeviceName":{
            "description":"The name of the device associated with the metric instance.",
            "type":"string",
            "example":"router.example.com"
        },
        "DeviceZoneName":{
            "description":"The zone name of the device associated with the metric instance.",
            "type":"string",
            "example":"Default First Zone"
        },
        "DeviceZoneID":{
            "description":"The zone ID of the device associated with the metric instance.",
            "type":"string",
            "example":"1"
        }
    },
    "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