introducing the tines admin api
Starting our deep-dive into new features included in the Tines Autumn 2019 release, we’re proud to announce the Admin API. In this post we’ll explore how the Admin API can be used to manage users, jobs and private templates.
Getting an API key
Like all Tines APIs, an API key is required to interact with the Admin API. A new API key can be generated from inside a user’s profile, however, to limit misuse only tenant admins can interact with the admin API.
Tines Admin API Postman collection
Postman is a powerful API client that makes testing and experimenting with APIs easy (we previously released a VirusTotal API Postman collection). Also, we also provide a Tines API Postman collection available on Github.
Download the v2 collection file from here and import it into Postman. The Tines collection contains examples for all admin actions.
Tines admins can use the User Admin APIs to programmatically manage users within their tenant. New user admin APIs includes endpoints for the following:
- List users
- Get a user
- Delete a user
- Create a user
- Update a user
- Get user signin activity
- Resend a user invitation
With the job management APIs, Tines admins can now perform common maintenance tasks such as monitoring the size of queues and deleting a malfunctioning agent’s retry jobs more easily. New job management admin APIs include endpoints for the following:
- Delete all an agent’s retry jobs
- List queued jobs
- Delete all an agent’s queued jobs
- Delete all queued jobs
- List dead jobs
- Delete all dead jobs
- List retry jobs
- Delete all retry jobs
- Delete all an agent’s dead jobs
Private templates allow Tines admins build agents that can be used as the basis for other agents throughout a tenant. While having programmatic access to manage private templates makes it trivial to automate the creation of agent templates for private APIs built by your company. The new admin API for private templates includes endpoints for the following:
- List private templates
- Get a private template
- Create a private template
- Update a private template
- Delete a private template
Up Next: How to Implode Events in Tines
Additional information on the Tines Admin APIs are available in the Tines Docs site: https://docs.tines.io/tines_api.html.