The Kentik V5 Admin APIs enable programmatic management of your organization’s Kentik admin settings.
Notes:
Member-level users can only access the GET methods of Admin APIs.
For an overview of all Kentik APIs, see Kentik APIs.
For information on using the V5 Admin APIs with cURL, see API Access Via cURL.
For help using any API version, contact [email protected].
About V5 Admin APIs
The Kentik V5 Admin APIs allow you to manage your organization’s Kentik settings programmatically. They provide methods to read/write backend information related to users, devices, sites, and tags. Information is returned in a JSON structure with key/value pairs within an HTTP response body.
For more details on the data accessible via each API for your organization, refer to the following articles:
User API: Data for each user registered on the Kentik system (see Users).
Device API: Data for each device (e.g., router, host) registered on the Kentik system (see About Devices).
Device Label API: Manage Labels for devices.
Plan API: Access data on “plans”, which are services provided to you by Kentik (see About Plans).
Site API: Access data on “sites”, which are groups of devices based on geographic location (see Site Field Definitions).
Tag API: Access data on tags (see Flow Tags).
Custom Dimension API: Access data on up to 10 custom dimensions and their associated populators (see Dimensions and Populators).
Saved Filter API: Access data on custom filters saved by your users, see (Company Saved Filters).
Alerting APIs: Manage and use Kentik’s alert-related features (Manual Mitigation only).
My Kentik API: Manage the My Kentik Portal programmatically.
Kentik V5 Admin APIs can be accessed via:
Command line: Use cURL in environments like Terminal (see API Access Via cURL).
Programmatically: Send a request body to a V5 API endpoint using any application language that supports HTTP.
Note: The V5 API tester was discontinued in January 2025.
V5 Admin Methods
The following table lists available methods in the V5 Admin APIs. Click the topic link for more details on each method:
Method | Endpoint | Description | Topic |
|---|---|---|---|
User API | |||
GET | /users | Get information about all users | |
GET | /user/user_id | Get information about a user | |
POST | /user | Create a new user | |
PUT | /user/user_id | Update user info | |
DELETE | /user/user_id | Delete a user | |
Device API | |||
GET | /devices | Get information about all devices | |
GET | /device/device_id | Get information about a device | |
POST | /device | Create a new device | |
PUT | /device/device_id | Update device info | |
DELETE | /device/device_id | Delete a device | |
GET | device/device_id/interfaces | Get information about all interfaces on a device | |
GET | device/device_id/interface/interface_id | Get information about an individual interface on a device | |
POST | device_id/interface | Create a new interface on a device | |
PUT | device/device_id/interface/interface_id | Update interface info | |
DELETE | device/device_id/interface/interface_id | Delete an interface | |
Device Label API | |||
GET | /deviceLabels | Get information about all labels | |
GET | /deviceLabels/label_id | Get information about a label | |
POST | /deviceLabels | Create a new label | |
PUT | /deviceLabels/label_id | Update label info | |
DELETE | /deviceLabels/label_id | Delete a label | |
Plan API | |||
GET | /plans | Get information about plans | |
Site API | |||
GET | /sites | Get information about all devices | |
GET | /site/site_id | Get information about a device | |
POST | /site | Create a new device | |
PUT | /site/site_id | Update device info | |
DELETE | /site/site_id | Delete a device | |
Tag API | |||
GET | /tags | Get information about all tags | |
GET | /tag/tag_id | Get information about a tag | |
POST | /tag | Create a new tag | |
PUT | /tag/tag_id | Update tag info | |
DELETE | /tag/tag_id | Delete a tag | |
Custom Dimension API | |||
GET | /customdimensions | Get information about all custom dimensions | |
GET | /customdimension/dimension_id | Get information about a custom dimension | |
POST | /customdimension | Create a new custom dimension | |
PUT | /customdimension/dimension_id | Update custom dimension info | |
DELETE | /customdimension/dimension_id | Delete a custom dimension | |
POST | /customdimension/dimension_id/populator | Create a new populator for a dimension | |
PUT | /customdimension/dimension_id/populator/populator_id | Update populator info | |
DELETE | /customdimension/dimension_id/populator/populator_id | Delete a populator | |
Batch API | |||
POST | /batch/tags | Create, update, or delete tags or populators by the batch. | |
GET | /batch/batch_operation_guid/status | Get status information about a batch operation. | |
Saved Filter API | |||
GET | /saved-filters/custom | Get information about all custom saved filters. | |
GET | /saved-filter/saved-filter/custom/savedfilter_id | Get information about a custom saved filter. | |
POST | /saved-filter/custom | Create a new custom saved filter. | |
PUT | /saved-filter/saved-filter/custom/savedfilter_id | Update custom saved filter info. | |
DELETE | /saved-filter/saved-filter/custom/savedfilter_id | Delete a custom saved filter. | |
Custom Application API | |||
GET | /customApplications | Get information about all custom applications. | |
POST | /customApplications | Create a new custom application. | |
PUT | /customApplications/application_id | Update custom application info. | |
DELETE | /customApplications/application_id | Delete a custom application. | |
Manual Mitigation API | |||
POST | alerts/manual-mitigate | Start a new manual mitigation | |
My Kentik API | |||
GET | /mykentik/tenants | Get information about all tenants. | |
GET | /mykentik/tenant/tenant_id | Get information about an individual tenant. | |
POST | /mykentik/tenant/tenant_id/user | Create a new tenant user. | |
DELETE | /mykentik/tenant/tenant_id/user/user_id | Delete a tenant user. | |
Note: Endpoint URLs are region-specific:
US:
https://api.kentik.com/api/v5EU:
https://api.kentik.eu/api/v5