@itentialopensource/adapter-kentik_v5

openapi: 3.0.0 info: title: Kentik V5 API (https://api.kentik.com/api/v5/) contact: {} version: '1.0' servers: - url: https://api.kentik.com/api/v5 variables: {} paths: /query/sql: post: tags: - Query Methods summary: runQuery description: This method allows you to run a SQL command against all configured devices. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_SQL_Method' target='_blank'>Documentation</a>. operationId: runQuery parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/runQuery' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /query/url: post: tags: - Query Methods summary: queryUrl description: Returns a URL to view a given query in Data Explorer. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_URL_Method' target='_blank'>Documentation</a>. operationId: queryUrl parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/queryUrl' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /query/topxdata: post: tags: - Query Methods summary: topxdata description: Returns query results in JSON that can be parsed to generate a TopX table. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_Data_Method' target='_blank'>Documentation</a>. operationId: topxdata parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/topxdata' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /query/topxchart: post: tags: - Query Methods summary: topxchart description: Returns an image of a graph similar to what is seen in the Kentik portal's Data Explorer. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_Chart_Method' target='_blank'>Documentation</a>. operationId: topxchart parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/topxchart' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /users: get: tags: - user summary: findUsers description: Returns an array of user objects, each of which contains information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>). * Required fields. operationId: findUsers parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /user/{user_id}: get: tags: - user summary: findUser description: Returns a user object containing information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>). * Required fields. operationId: findUser parameters: - name: user_id in: path description: The ID of the user whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - user summary: updateUser description: Updates and returns a user object containing information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>). * Required fields. operationId: updateUser parameters: - name: user_id in: path description: The ID of the user whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateUser' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - user summary: deleteUser description: Deletes a user from the system. * Required fields. operationId: deleteUser parameters: - name: user_id in: path description: The id of the user to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /user: post: tags: - user summary: createUser description: Creates and returns a user object containing information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>). * Required fields. operationId: createUser parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createUser' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /devices: get: tags: - device summary: findDevices description: Returns an array of device objects that each contain information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>). * Required fields. operationId: findDevices parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /device/{device_id}: get: tags: - device summary: findDevice description: Returns a device object containing information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>). * Required fields. operationId: findDevice parameters: - name: device_id in: path description: The id of the device whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - device summary: updateDevice description: Updates and returns a device object containing information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>). * Required fields. operationId: updateDevice parameters: - name: device_id in: path description: The id of the device whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateDevice' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - device summary: deleteDevice description: Deletes a device. * Required fields. operationId: deleteDevice parameters: - name: device_id in: path description: The id of the device to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /device: post: tags: - device summary: createDevice description: Creates and returns a device object containing information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>). * Required fields. ** Conditionally required fields. operationId: createDevice parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createDevice' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /devices/{device_id}/labels: put: tags: - device summary: deviceApplyLabels description: Removes all existing labels from the device and applies the device labels (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-About_Device_Labels' target='_blank'>About Device Labels</a>) specified by id. Returns a reduced version of device object containing an array of the applied labels. * Required fields. operationId: deviceApplyLabels parameters: - name: device_id in: path description: The id of the device whose labels will be applied. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/deviceApplyLabels' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /device/{device_id}/interfaces: get: tags: - device summary: findInterfaces description: Returns an array of interface objects that each contain information about an interface from a specified device. * Required fields. operationId: findInterfaces parameters: - name: device_id in: path description: The id of the device whose interfaces will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /device/{device_id}/interface/{interface_id}: get: tags: - device summary: findInterface description: Returns a interface object containing information about an individual interface from a given device. * Required fields. operationId: findInterface parameters: - name: device_id in: path description: The id of the device whose interface information will be returned. required: true style: simple schema: type: integer format: int32 - name: interface_id in: path description: The id of the interface whose information will be returned. This is NOT the same as the interface's SNMP ID. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - device summary: updateInterface description: Updates and returns an interface object containing information about an individual interface from a specified device. * Required fields. *** Alternatively, instead of defining a vrf object, you can add the vrf_id. operationId: updateInterface parameters: - name: device_id in: path description: The id of the device whose interface information will be updated. required: true style: simple schema: type: integer format: int32 - name: interface_id in: path description: The id of the interface whose information will be updated. This is NOT the same as the SNMP ID. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateInterface' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - device summary: deleteInterface description: Deletes an interface from a given device. * Required fields. operationId: deleteInterface parameters: - name: device_id in: path description: The id of the device from which to delete the specified interface. required: true style: simple schema: type: integer format: int32 - name: interface_id in: path description: The id of the interface to delete from the specified device. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /device/{device_id}/interface: post: tags: - device summary: createInterface description: Creates and returns an interface object containing information about an individual interface for a given device. * Required fields. *** Alternatively, instead of defining a vrf object, you can add the vrf_id. operationId: createInterface parameters: - name: device_id in: path description: The id of the device to which you want to add an interface. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createInterface' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /deviceLabels: get: tags: - device label summary: findDeviceLabels description: Returns an array of device label objects that each contain information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>). * Required fields. operationId: findDeviceLabels parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false post: tags: - device label summary: createDeviceLabel description: Creates and returns a device label object containing information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>). * Required fields. ** Conditionally required fields. operationId: createDeviceLabel parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createDeviceLabel' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /deviceLabels/{device_label_id}: get: tags: - device label summary: findDeviceLabel description: Returns a device label object containing information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>). * Required fields. operationId: findDeviceLabel parameters: - name: device_label_id in: path description: The id of the device label whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - device label summary: updateDeviceLabel description: Updates and returns a device label object containing information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>). * Required fields. operationId: updateDeviceLabel parameters: - name: device_label_id in: path description: The id of the device label whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateDeviceLabel' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - device label summary: deleteDeviceLabel description: Deletes a device label. * Required fields. operationId: deleteDeviceLabel parameters: - name: device_label_id in: path description: The id of the device label to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /plans: get: tags: - plan summary: findPlans description: Returns an array of plan objects, each of which contains information about an individual plan. operationId: findPlans parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /sites: get: tags: - site summary: findSites description: Returns an array of site objects, each of which contains information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>). * Required fields. operationId: findSites parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /site/{site_id}: get: tags: - site summary: findSite description: Returns a site object containing information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>). * Required fields. operationId: findSite parameters: - name: site_id in: path description: The ID of the site whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - site summary: updateSite description: Updates and returns a site object containing information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>). * Required fields. operationId: updateSite parameters: - name: site_id in: path description: The id of the site whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateSite' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - site summary: deleteSite description: Deletes a site. * Required fields. operationId: deleteSite parameters: - name: site_id in: path description: The id of the site to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /site: post: tags: - site summary: createSite description: Creates and returns a site object containing information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>). * Required fields. operationId: createSite parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createSite' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /tags: get: tags: - tag summary: findTags description: Returns an array of tag objects that each contain information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>). operationId: findTags parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /tag/{tag_id}: get: tags: - tag summary: findTag description: Returns a tag object containing information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>). * Required fields. operationId: findTag parameters: - name: tag_id in: path description: The id of the tag whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - tag summary: updateTag description: Updates and returns a tag object containing information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>). * Required fields. operationId: updateTag parameters: - name: tag_id in: path description: The id of the tag whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateTag' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - tag summary: deleteTag description: Deletes a tag. * Required fields. operationId: deleteTag parameters: - name: tag_id in: path description: The id of the tag to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /tag: post: tags: - tag summary: createTag description: Creates and returns a tag object containing information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>). * Required fields. operationId: createTag parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createTag' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customdimensions: get: tags: - custom_dimension summary: findCustomDimensions description: Returns an array of custom dimension objects that each contain information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>). operationId: findCustomDimensions parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customdimension/{dimension_id}: get: tags: - custom_dimension summary: findCustomDimension description: Returns a custom dimension object containing information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>). * Required fields. operationId: findCustomDimension parameters: - name: dimension_id in: path description: The id of the custom dimension whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - custom_dimension summary: updateCustomDimension description: Updates and returns a custom dimension object containing information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>). * Required fields. Populators are not sent back in the response body. To get them use "Custom Dimension info" section instead. operationId: updateCustomDimension parameters: - name: dimension_id in: path description: The id of the custom dimension whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateCustomDimension' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - custom_dimension summary: deleteCustomDimension description: Deletes a custom dimension. * Required fields. operationId: deleteCustomDimension parameters: - name: dimension_id in: path description: The id of the custom dimension to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customdimension: post: tags: - custom_dimension summary: createCustomDimension description: Creates and returns a custom dimension object containing information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>). * Required fields. operationId: createCustomDimension parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createCustomDimension' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customdimension/{dimension_id}/populator/: post: tags: - custom_dimension summary: createPopulator description: Creates and returns a populator object containing information about an individual populator (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Populators</a>). * Required fields. operationId: createPopulator parameters: - name: dimension_id in: path description: The id of the custom dimension that contains the populator. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createPopulator' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customdimension/{dimension_id}/populator/{populator_id}: put: tags: - custom_dimension summary: updatePopulator description: Updates and returns a populator object containing information about an individual populator (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Populators</a>). * Required fields. operationId: updatePopulator parameters: - name: populator_id in: path description: The id of the populator whose information will be updated. required: true style: simple schema: type: integer format: int32 - name: dimension_id in: path description: The id of the custom dimension that contains the populator. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updatePopulator' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - custom_dimension summary: deletePopulator description: Deletes a populator. * Required fields. operationId: deletePopulator parameters: - name: populator_id in: path description: The id of the populator to delete. required: true style: simple schema: type: integer format: int32 - name: dimension_id in: path description: The id of the custom dimension that contains the populator to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customApplications: get: tags: - custom_application summary: findCustomApplications description: Returns an array of custom application object, each of which contains information about an individual custom application. * Required fields. operationId: findCustomApplications parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false post: tags: - custom_application summary: createCustomApplication description: Creates and returns a custom application object containing information about an individual custom application. * Required fields. operationId: createCustomApplication parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createCustomApplication' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /customApplications/{application_id}: put: tags: - custom_application summary: updateCustomApplication description: Updates and returns a custom application object containing information about an individual custom application. * Required fields. operationId: updateCustomApplication parameters: - name: application_id in: path description: The ID of the custom application whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateCustomApplication' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - custom_application summary: deleteCustomApplication description: Deletes a custom application from the system. * Required fields. operationId: deleteCustomApplication parameters: - name: application_id in: path description: The id of the custom application to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /saved-filters/custom: get: tags: - savedfilter summary: findSavedFilters description: Returns an array of saved filter objects, each of which contains information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_List' target='_blank'>Saved Filters</a>). * Required fields. operationId: findSavedFilters parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /saved-filter/custom/{savedfilter_id}: get: tags: - savedfilter summary: findSavedFilter description: Returns a saved filter object containing information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_Info' target='_blank'>Saved Filters</a>). * Required fields. operationId: findSavedFilter parameters: - name: savedfilter_id in: path description: The ID of the saved filter whose information will be returned. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false put: tags: - savedfilter summary: updateSavedFilter description: Updates and returns a saved filter object containing information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_Update' target='_blank'>Saved Filters</a>). * Required fields. operationId: updateSavedFilter parameters: - name: savedfilter_id in: path description: The ID of the saved filter whose information will be updated. required: true style: simple schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/updateSavedFilter' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false delete: tags: - savedfilter summary: deleteSavedFilter description: Deletes a saved filter from the system. * Required fields. operationId: deleteSavedFilter parameters: - name: savedfilter_id in: path description: The id of the saved filter to delete. required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /saved-filter/custom: post: tags: - savedfilter summary: createSavedFilter description: Creates and returns a saved filter object containing information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_Create' target='_blank'>Saved Filters</a>). * Required fields. operationId: createSavedFilter parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createSavedFilter' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /alerts/manual-mitigate: post: tags: - alerts summary: createManualMitigation description: Creates a manual mitigation. A mitigation started manually will not clear on its own. It must be stopped manually from the active alerts page. operationId: createManualMitigation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/createManualMitigation' required: true responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /alerts-active/alarms: get: tags: - alerts_active summary: alarms description: Returns alarms. operationId: alarms parameters: - name: startTime in: query description: startTime - The startTime of the alert. E.g. "2018-10-15T22:15:00". required: true style: form explode: true schema: type: string - name: endTime in: query description: endTime - The endTime of the alert. E.g. "2018-10-15T22:16:00". required: true style: form explode: true schema: type: string - name: filterBy in: query description: 'filterBy - The filter by field. (Acceptable values are: "", "old_state", "new_state", "any_state", "alert_key_partial", "dimension_key", "mitigation_id", "alert_id", "alert_key", "alarm_id")' required: true style: form explode: true schema: type: string - name: filterVal in: query description: filterVal - The filter by value. required: true style: form explode: true schema: type: string - name: showMitigations in: query description: showMitigations - 0 showMitigations off, 1 showMitigations on. required: true style: form explode: true schema: type: integer format: int32 - name: showAlarms in: query description: showAlarms - 0 showAlarms off, 1 showAlarms on. required: true style: form explode: true schema: type: integer format: int32 - name: showMatches in: query description: showMatches - 0 showMatches off, 1 showMatches on. required: true style: form explode: true schema: type: integer format: int32 - name: learningMode in: query description: learningMode - 0 learning mode off, 1 learning mode on. required: true style: form explode: true schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /alerts-active/alerts-history: get: tags: - alerts_active summary: alertsHistory description: Returns alerts history. operationId: alertsHistory parameters: - name: startTime in: query description: startTime - The startTime of the alert. E.g. "2018-10-15T22:15:00". required: true style: form explode: true schema: type: string - name: endTime in: query description: endTime - The endTime of the alert. E.g. "2018-10-15T22:16:00". required: true style: form explode: true schema: type: string - name: filterBy in: query description: 'filterBy - The filter by field. (Acceptable values are: "", "old_state", "new_state", "any_state", "alert_key_partial", "dimension_key", "mitigation_id", "alert_id", "alert_key", "alarm_id")' required: true style: form explode: true schema: type: string - name: filterVal in: query description: filterVal - The filter by value. required: true style: form explode: true schema: type: string - name: sortOrder in: query description: 'sortOrder - The dimension to sort by. (Acceptable values are: "alert_key", "severity", "mitigation_id", "alarm_id", "alert_id", "alert_value", "alarm_state")' required: true style: form explode: true schema: type: string - name: showMitigations in: query description: showMitigations - 0 showMitigations off, 1 showMitigations on. required: true style: form explode: true schema: type: integer format: int32 - name: showAlarms in: query description: showAlarms - 0 showAlarms off, 1 showAlarms on. required: true style: form explode: true schema: type: integer format: int32 - name: showMatches in: query description: showMatches - 0 showMatches off, 1 showMatches on. required: true style: form explode: true schema: type: integer format: int32 - name: learningMode in: query description: learningMode - 0 learning mode off, 1 learning mode on. required: true style: form explode: true schema: type: integer format: int32 responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /mykentik/tenants: get: tags: - My Kentik Portal summary: findUserGroups description: Returns an array of tenants, each of which contains information about an individual tenant (see <a href='https://kb.kentik.com/Cb15.htm#Cb15-Tenant_List' target='_blank'>Tenant List</a>). * Required fields. operationId: findUserGroups parameters: [] responses: '200': description: '' headers: {} content: application/json: schema: type: object deprecated: false /mykentik/tenant/{tenant_id}: get: