Typesense Cloud Management API
In this article
In this article group
The Typesense Cloud Management API lets you create and manage your clusters from your own code, instead of clicking buttons in the Typesense Cloud dashboard.
This is different from the Typesense Server API, which you use to index and search data in a cluster. If you're familiar with AWS or GCP, the Management API is to your Typesense clusters what the AWS / GCP APIs are to your cloud resources.
Example use cases
Spin up a cluster for each environment or for each of your own customers.
Scale a cluster up ahead of a big sale and back down after.
Rotate your cluster's API keys on a schedule.
Pull invoices and per-cluster costs into your accounting or internal reporting tools.
Bring search insights and synonym suggestions into your own admin tools.
What you can manage
Resource | What you can do |
|---|---|
Create, list, rename and terminate clusters, and look up the regions, RAM and vCPU options | |
Change RAM, vCPU, High Availability, Typesense version and more, right away or at a scheduled time | |
Restart a cluster's nodes one at a time | |
Clone a cluster | |
Change backup settings, list backups and restore them | |
Change Typesense Server Parameters, like the slow-request logging threshold | |
List, create and revoke a cluster's API keys | |
Limit which IP addresses can reach a cluster | |
Share one cluster's dashboard with someone who doesn't have a Typesense Cloud account | |
Read per-node metrics and request logs, including slow requests | |
Read what your users search for, and get synonyms for searches that found nothing | |
Read invoices and spend by month or by cluster, and switch between weekly and monthly billing |
Getting started
To create a Management API key, go to your account page, scroll down and click on "Read More" next to "Need programmatic access to create clusters?". Then pick the key's capabilities.
Read the API docs here.