{
  "swagger" : "2.0",
  "info" : {
    "description" : "",
    "version" : "",
    "title" : "",
    "termsOfService" : ""
  },
  "basePath" : "/netq/telemetry/{api_version}",
  "schemes" : [ "https" ],
  "paths" : {
    "/object/events/ack" : {
      "post" : {
        "tags" : [ "events" ],
        "summary" : "Acknowledges given event info",
        "description" : "",
        "operationId" : "postAckObject",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "api_version",
          "in" : "path",
          "description" : "Supported versions",
          "required" : false,
          "type" : "string",
          "default" : "v1",
          "enum" : [ "v1" ]
        } ],
        "security" : [ {
          "jwt" : [ ]
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "properties" : { }
                }
              }
            }
          }
        }
      }
    },
    "/object/events" : {
      "get" : {
        "tags" : [ "events" ],
        "summary" : "Get all events for all network devices and services.",
        "description" : "Retrieves all alarm and informational events from all network devices and services.",
        "operationId" : "getObjectByOpId",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "details",
          "in" : "query",
          "description" : "details",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "duration",
          "in" : "query",
          "description" : "duration",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "bucket",
          "in" : "query",
          "description" : "bucket",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "timestamp",
          "in" : "query",
          "description" : "timestamp",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "event_state_type",
          "in" : "query",
          "description" : "event_state_type",
          "required" : false,
          "type" : "string",
          "enum" : [ "severity", "state" ]
        }, {
          "name" : "event_state",
          "in" : "query",
          "description" : "event_state",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "filter_by",
          "in" : "query",
          "description" : "filter_by",
          "required" : false,
          "type" : "string",
          "enum" : [ "most_active_devices" ]
        }, {
          "name" : "max_active_devices",
          "in" : "query",
          "description" : "max_active_devices",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "time",
          "in" : "query",
          "description" : "time",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "category",
          "in" : "query",
          "description" : "category",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "gt_timestamp",
          "in" : "query",
          "description" : "Used in combination with lt_timestamp, sets the lower limit of the time range to display. Uses Epoch format. Cannot be used with eq_timestamp. For example, to display events between Monday February 11, 2019 at 1:00am and Tuesday February 12, 2019 at 1:00am, lt_timestamp would be entered as 1549864800 and gt_timestamp would be entered as 1549951200.",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "lt_timestamp",
          "in" : "query",
          "description" : "Used in combination with gt_timestamp, sets the upper limit of the time range to display. Uses Epoch format. Cannot be used with eq_timestamp. For example, to display events between Monday February 11, 2019 at 1:00am and Tuesday February 12, 2019 at 1:00am, lt_timestamp would be entered as 1549864800 and gt_timestamp would be entered as 1549951200.",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "eq_timestamp",
          "in" : "query",
          "description" : "Display results for a given time. Time must be entered in Epoch format. For example, to display the results for Monday February 13, 2019 at 1:25 pm, use a time converter and enter 1550082300.p",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "count",
          "in" : "query",
          "description" : "Number of entries to display starting from the offset value. For example, a count of 100 displays 100 entries at a time.",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Used in combination with count, offset specifies the starting location within the set of entries returned. For example, an offset of 100 would display results beginning with entry 101.",
          "required" : false,
          "type" : "integer"
        }, {
          "name" : "api_version",
          "in" : "path",
          "description" : "Supported versions",
          "required" : false,
          "type" : "string",
          "default" : "v1",
          "enum" : [ "v1" ]
        } ],
        "security" : [ {
          "jwt" : [ ]
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }
  },
  "securityDefinitions" : {
    "jwt" : {
      "type" : "apiKey",
      "name" : "Authorization",
      "in" : "header"
    }
  },
  "definitions" : {
    "SortInfo" : {
      "type" : "object",
      "required" : [ "max_sort_rows", "sort_columns" ],
      "properties" : {
        "sort_columns" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "max_sort_rows" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "DeviceKey" : {
      "type" : "object",
      "properties" : {
        "opid" : {
          "type" : "integer",
          "format" : "int32",
          "description" : "unique on-premise identifier"
        },
        "hostname" : {
          "type" : "string",
          "description" : "hostname of a device"
        }
      },
      "description" : "unique device key"
    },
    "ObjectKey" : {
      "type" : "object",
      "properties" : {
        "deviceKey" : {
          "description" : "unique device key",
          "$ref" : "#/definitions/DeviceKey"
        },
        "objectDeviceKey" : {
          "type" : "object",
          "description" : "unique object key within a given device. This is a generic type",
          "properties" : { }
        }
      },
      "description" : "unique object key"
    },
    "BucketStats" : {
      "type" : "object",
      "properties" : {
        "deviceKey" : {
          "description" : "unique device key",
          "$ref" : "#/definitions/DeviceKey"
        },
        "bucketNumber" : {
          "type" : "integer",
          "format" : "int32",
          "description" : "unique bucket number"
        },
        "ipv4" : {
          "type" : "integer",
          "format" : "int32",
          "description" : "IPV4 Count"
        },
        "ipv6" : {
          "type" : "integer",
          "format" : "int32",
          "description" : "IPV4 Count"
        },
        "total" : {
          "type" : "integer",
          "format" : "int32",
          "description" : "unique bucket number"
        }
      },
      "description" : "Bucket Stats"
    }
  }
}