CH logo® Knowledge Base
Contents Search
   

 

Admin APIs

Note: Users whose level is Member have access only to the GET methods of Admin APIs.

The Kentik V5 Admin APIs enable programmatic management of your company’s Kentik Detect admin settings. The V5 Admin APIs are covered in the following topics:

Notes:
- For an overview of all Kentik APIs, see APIs Overview.
- For information on using the V5 Admin APIs with cURL, see API Access Via cURL.
- For documentation of the V5 Query API, see V5 Query API.
- For assistance using any API version please contact support@Kentik.com.

 

 
 top

About V5 Admin APIs

The Kentik V5 Admin APIs enable programmatic management of your company’s Kentik Detect settings. The interfaces support methods that write to or read from backend information, maintained by Kentik for each company, in areas such as users, devices, sites, and tags. Calls that return information do so in key:value pairs in a JSON structure within an HTTP response body.

Additional information about the data that can be accessed by each API is covered in the following API articles:

  • User API: Data related to each user registered on the Kentik system for a given customer (organization); see User Admin.
  • Device API: Data related to each device (router or host) registered on the Kentik system for a given customer (organization); see Device Admin.
  • Plan API: Data related to “plans” that are created by Kentik to represent the characteristics of the Kentik Detect service provided by Kentik to a customer; see About Plans.
  • Site API: Data related to “sites” that may optionally be used to assign devices to groups based on geographic location. See Site Field Definitions.
  • Tag API: Data related to each tag defined on the system for a given customer (organization); see Flow Tags.
  • Custom Dimension API: Data related to each custom dimension (up to 10) defined on the system for a given customer (organization), plus the populators associated with those dimensions; see Dimensions and Populators.
  • Saved Filter API: Data related to custom filters (as distinct from preset filters provided by Kentik) saved by users in your organization; see About Company Filters.

Kentik V5 Admin APIs may be accessed as follows:

  • V5 Admin API Tester Page: Use the V5 Admin API tester (ioDocs), which allows you to try the API calls on real data from your Kentik Detect service.
  • Command line: Use cURL (https://curl.haxx.se/) in an environment like Terminal. See API Access Via cURL.
  • Programmatically: Pass a request body to a V5 API endpoint using any application language that supports the HTTP protocol.

 

 
 top

V5 Admin Methods

The following table shows the methods that are available in the V5 Admin APIs (click on the topic link for more information about a specific method):

Method Endpoint Description Topic
User API
GET /users Get information about all users User List
GET /user/user_id Get information about a user User Info
POST /user Creates a new user User Create
PUT /user/user_id Update user info User Update
DELETE /user/user_id Delete a user User Delete
Device API
GET /devices Get information about all devices Device List
GET /device/device_id Get information about a device Device Info
POST /device Creates a new device Device Create
PUT /device/device_id Update device info Device Update
DELETE /device/device_id Delete a device Device Delete
GET device/device_id/interfaces Get information about all interfaces on a device Interface List
GET device/device_id/interface/interface_id Get information about an individual interface on a device Interface Info
POST device_id/interface Create a new interface on a device Interface Create
PUT device/device_id/interface/interface_id Update interface info Interface Update
DELETE device/device_id/interface/interface_id Delete an interface Interface Delete
Plan API
GET /plans Get information about plans Plan List
Site API
GET /sites Get information about all devices Site List
GET /site/site_id Get information about a device Site Info
POST /site Creates a new device Site Create
PUT /site/site_id Update device info Site Update
DELETE /site/site_id Delete a device Site Delete
Tag API
GET /tags Get information about all tags Tag List
GET /tag/tag_id Get information about a tag Tag Info
POST /tag Create a new tag Tag Create
PUT /tag/tag_id Update tag info Tag Update
DELETE /tag/tag_id Delete a tag Tag Delete
Custom Dimension API
GET /customdimensions Get information about all custom dimensions Custom Dimension List
GET /customdimension/dimension_id Get information about a custom dimension Custom Dimension Info
POST /customdimension Create a new custom dimension Custom Dimension Create
PUT /customdimension/dimension_id Update custom dimension info Custom Dimension Update
DELETE /customdimension/dimension_id Delete a custom dimension Custom Dimension Delete
POST /customdimension/dimension_id/populator Create a new populator for a dimension Populator Create
PUT /customdimension/dimension_id/populator/populator_id Update populator info Populator Update
DELETE /customdimension/dimension_id/populator/populator_id Delete a populator Populator Delete
Saved Filter API
GET /saved-filters/custom Get information about all custom saved filters. Saved Filter List
GET /saved-filter/saved-filter/custom/savedfilter_id Get information about a custom saved filter Saved Filter Info
POST /saved-filter/custom Create a new custom saved filter Saved Filter Create
PUT /saved-filter/saved-filter/custom/savedfilter_id Update custom saved filter info Saved Filter Update
DELETE /saved-filter/saved-filter/custom/savedfilter_id Delete a custom saved filter Saved Filter Delete

Note: Paths shown above are relative to https://api.kentik.com/api/v5.

 

In this article: