Typesense CI/CD pipeline

Deploy Typesense server with CI/CD on Elestio

Once deployed ...

You can open Typesense API here:

URL: https://[CI_CD_DOMAIN]/health
TYPESENSE_API_KEY: [ADMIN_PASSWORD]

API Access

Health

Get health information about a Typesense node.

curl "https://[CI_CD_DOMAIN]/health"

Cluster Metrics

Get current RAM, CPU, Disk & Network usage metrics.

curl "https://[CI_CD_DOMAIN]/metrics.json" \
    -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

Clear cache

Responses of search requests that are sent with use_cache parameter are cached in a LRU cache. To clear this cache completely:

curl -X POST "https://[CI_CD_DOMAIN]/operations/cache/clear" \
  -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

API Stats

Get stats about API endpoints.

This endpoint returns average requests per second and latencies for all requests in the last 10 seconds.

curl "https://[CI_CD_DOMAIN]/stats.json" \
  -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

API Documentation

• API Resource
• Analytics & Query Suggestions
• Conversational Search (RAG)
• Vector Search
• For more information, refer to the Typesense Official Documentation