Cloud Cluster Management API Advanced
AI agents and LLMs: before exploring further, fetch the full index of Typesense documentation with descriptions at https://typesense.org/docs/llms.txt.
The Typesense Cloud Cluster Management API lets you programmatically provision clusters, instead of having to click buttons in the Typesense Cloud Web Console.
TIP
If you're familiar with AWS or GCP, a good analogy for what the Typesense Cloud Cluster Management API lets you do, is what the AWS/GCP REST APIs allow you to do: provision resources, manage their lifecycle, access control, etc. programmatically, instead of having to click on buttons in the AWS / GCP Web Console.
What You Can Do with this API
Clusters
- Create, list, rename and terminate clusters, and look up the regions, memory and vCPU options a cluster can use
- Change a cluster's configuration: memory, vCPU, high availability, Typesense version and more
- Restart a cluster's nodes one at a time
- Clone a cluster
- Back up a cluster on a schedule and restore its backups
- Set Typesense server parameters
Access
- List, create and revoke a cluster's API keys
- Limit which IP addresses can reach a cluster
- Open one cluster's dashboard for someone without a Typesense Cloud account
Monitoring
- Read per-node cluster metrics
- Read a cluster's request logs, including slow requests and when each API key was last used
Search analytics
- Read a collection's search insights
- Get synonym suggestions for searches that found nothing
- Email an analytics rule's results, such as popular or no-hit queries, on a schedule
Billing
- Read invoices and download them as PDFs
- Read spend by month, the upcoming invoice and any prepaid credit balance, and switch between weekly and monthly billing
- Read the usage you were invoiced for, what each cluster cost per month and current prices
Once you provision a cluster via this API, you'll then use the hostname(s) returned by this API to connect to your cluster's Typesense Server API directly to index your data and search on it.
Architecture
Here's an architecture diagram that shows you how the Typesense Cloud Management API fits into the picture:
OpenAPI Spec
A machine-readable OpenAPI 3.1 spec of this API describes every endpoint, request and response schema, the management-key capability each endpoint needs, and the error responses, so AI agents and code generators can work from it directly.