Kentik V5 API (https://api.kentik.com/api/v5/)

Query Methods
- List Methods
- Expand Methods
- POSTQuery SQL/query/sql
  This method allows you to run a SQL command against all configured devices. Documentation.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTquery Url/query/url
  Returns a URL to view a given query in Data Explorer. Documentation.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTQuery Data/query/topxdata
  Returns query results in JSON that can be parsed to generate a TopX table. Documentation.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTQuery Chart/query/topxchart
  Returns an image of a graph similar to what is seen in the Kentik portal's Data Explorer. Documentation.
  
  Description
  Location
  Type
  Value
  Parameter
user
- List Methods
- Expand Methods
- GETUser list/users
  Returns an array of user objects, each of which contains information about an individual user (see User Field Definitions).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETUser info/user/{user_id}
  Returns a user object containing information about an individual user (see User Field Definitions).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTUser create/user
  Creates and returns a user object containing information about an individual user (see User Field Definitions).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUser update/user/{user_id}
  Updates and returns a user object containing information about an individual user (see User Field Definitions).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEUser delete/user/{user_id}
  Deletes a user from the system.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
device
- List Methods
- Expand Methods
- GETDevice list/devices
  Returns an array of device objects that each contain information about an individual device (see About Devices).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETDevice info/device/{device_id}
  Returns a device object containing information about an individual device (see About Devices).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTDevice create/device
  Creates and returns a device object containing information about an individual device (see About Devices).
  * Required fields.
  ** Conditionally required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTDevice update/device/{device_id}
  Updates and returns a device object containing information about an individual device (see About Devices).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTDevice apply labels/devices/{device_id}/labels
  Removes all existing labels from the device and applies the device labels (see About Device Labels) specified by id. Returns a reduced version
  of device object containing an array of the applied labels.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEDevice delete/device/{device_id}
  Deletes a device.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETInterface list/device/{device_id}/interfaces
  Returns an array of interface objects that each contain information about an interface from a specified device.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETInterface info/device/{device_id}/interface/{interface_id}
  Returns a interface object containing information about an individual interface from a given device.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTInterface create/device/{device_id}/interface
  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.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTInterface update/device/{device_id}/interface/{interface_id}
  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.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEInterface delete/device/{device_id}/interface/{interface_id}
  Deletes an interface from a given device.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
device label
- List Methods
- Expand Methods
- GETDevice label list/deviceLabels
  Returns an array of device label objects that each contain information about an individual device label (see Device Labels).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETDevice label info/deviceLabels/{device_label_id}
  Returns a device label object containing information about an individual device label (see Device Labels).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTDevice label create/deviceLabels
  Creates and returns a device label object containing information about an individual device label (see Device Labels).
  * Required fields.
  ** Conditionally required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTDevice label update/deviceLabels/{device_label_id}
  Updates and returns a device label object containing information about an individual device label (see Device Labels).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEDevice label delete/deviceLabels/{device_label_id}
  Deletes a device label.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
plan
- List Methods
- Expand Methods
- GETPlan list/plans
  Returns an array of plan objects, each of which contains information about an individual plan.
  
  Description
  Location
  Type
  Value
  Parameter
site
- List Methods
- Expand Methods
- GETSite list/sites
  Returns an array of site objects, each of which contains information about an individual site (see About Sites).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETSite info/site/{site_id}
  Returns a site object containing information about an individual site (see About Sites).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTSite create/site
  Creates and returns a site object containing information about an individual site (see About Sites).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTSite update/site/{site_id}
  Updates and returns a site object containing information about an individual site (see About Sites).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETESite delete/site/{site_id}
  Deletes a site.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
tag
- List Methods
- Expand Methods
- GETTag list/tags
  Returns an array of tag objects that each contain information about an individual tag (see About Tags).
  
  Description
  Location
  Type
  Value
  Parameter
- GETTag info/tag/{tag_id}
  Returns a tag object containing information about an individual tag (see About Tags).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTTag create/tag
  Creates and returns a tag object containing information about an individual tag (see About Tags).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTTag update/tag/{tag_id}
  Updates and returns a tag object containing information about an individual tag (see About Tags).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETETag delete/tag/{tag_id}
  Deletes a tag.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
custom_dimension
- List Methods
- Expand Methods
- GETCustom Dimension list/customdimensions
  Returns an array of custom dimension objects that each contain information about an individual custom dimension (see About Custom Dimensions).
  
  Description
  Location
  Type
  Value
  Parameter
- GETCustom Dimension info/customdimension/{dimension_id}
  Returns a custom dimension object containing information about an individual custom dimension (see About Custom Dimensions).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTCustom Dimension create/customdimension
  Creates and returns a custom dimension object containing information about an individual custom dimension (see About Custom Dimensions).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTCustom Dimension update/customdimension/{dimension_id}
  Updates and returns a custom dimension object containing information about an individual custom dimension (see About Custom Dimensions).
  * Required fields.
  Populators are not sent back in the response body. To get them use "Custom Dimension info" section instead.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETECustom Dimension delete/customdimension/{dimension_id}
  Deletes a custom dimension.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTPopulator create/customdimension/{dimension_id}/populator/
  Creates and returns a populator object containing information about an individual populator (see About Populators).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTPopulator update/customdimension/{dimension_id}/populator/{populator_id}
  Updates and returns a populator object containing information about an individual populator (see About Populators).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEPopulator delete/customdimension/{dimension_id}/populator/{populator_id}
  Deletes a populator.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
custom_application
- List Methods
- Expand Methods
- GETCustom Applications list/customApplications
  Returns an array of custom application object, each of which contains information about an individual custom application.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTCustom Application create/customApplications
  Creates and returns a custom application object containing information about an individual custom application.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTCustom Application update/customApplications/{application_id}
  Updates and returns a custom application object containing information about an individual custom application.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETECustom Application delete/customApplications/{application_id}
  Deletes a custom application from the system.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
savedfilter
- List Methods
- Expand Methods
- GETSaved Filters list/saved-filters/custom
  Returns an array of saved filter objects, each of which contains information about an individual saved filter (see Saved Filters).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETSaved Filter info/saved-filter/custom/{savedfilter_id}
  Returns a saved filter object containing information about an individual saved filter (see Saved Filters).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTSaved Filter create/saved-filter/custom
  Creates and returns a saved filter object containing information about an individual saved filter (see Saved Filters).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTSaved Filter update/saved-filter/custom/{savedfilter_id}
  Updates and returns a saved filter object containing information about an individual saved filter (see Saved Filters).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETESaved Filter delete/saved-filter/custom/{savedfilter_id}
  Deletes a saved filter from the system.
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
alerts
- List Methods
- Expand Methods
- POSTManual Mitigation create/alerts/manual-mitigate
  Creates a manual mitigation. A mitigation started manually will not clear on its own. It must be stopped manually from the active alerts page.
  
  Description
  Location
  Type
  Value
  Parameter
alerts_active
- List Methods
- Expand Methods
- GETAlarms/alerts-active/alarms?startTime={startTime}&endTime={endTime}&filterBy={filterBy}&filterVal={filterVal}&showMitigations={showMitigations}&showAlarms={showAlarms}&showMatches={showMatches}&learningMode={learningMode}
  Returns alarms.
  
  Description
  Location
  Type
  Value
  Parameter
- GETAlerts History/alerts-active/alerts-history?startTime={startTime}&endTime={endTime}&filterBy={filterBy}&filterVal={filterVal}&sortOrder={sortOrder}&showMitigations={showMitigations}&showAlarms={showAlarms}&showMatches={showMatches}&learningMode={learningMode}
  Returns alerts history.
  
  Description
  Location
  Type
  Value
  Parameter
My Kentik Portal
- List Methods
- Expand Methods
- GETTenant list/mykentik/tenants
  Returns an array of tenants, each of which contains information about an individual tenant (see Tenant List).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- GETTenant info/mykentik/tenant/{tenant_id}
  Returns a tenant object containing information about an individual tenant (see Tenant Dialogs).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTTenant User create/mykentik/tenant/{tenant_id}/user
  Creates and returns a tenant user object containing information about an individual tenant user (see Add a Tenant User).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETETenant User delete/mykentik/tenant/{tenant_id}/user/{user_id}
  Deletes a tenant user from the system (see Remove a Tenant User).
  * Required fields.
  
  Description
  Location
  Type
  Value
  Parameter