Typesense Server Configuration Parameters API

Manage Typesense Server configuration parameters for cloud clusters.

Operations 2

GET /clusters/{clusterId}/typesense-server-configuration-parameters Get Server Configuration Parameters #
PATCH /clusters/{clusterId}/typesense-server-configuration-parameters Update Server Configuration Parameters #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/typesense-server-configuration-parameters-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

typesense-server-configuration-parameters-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Typesense Cloud Management Server Configuration Parameters API
  description: The Typesense Cloud Management API provides endpoints for provisioning and managing Typesense Cloud clusters programmatically. It supports creating, updating, and deleting clusters, managing cluster configuration parameters, generating API keys, and applying configuration changes. This API enables infrastructure automation for teams running Typesense on the managed cloud platform, with authentication handled through cloud management API keys.
  version: '1'
  contact:
    name: Typesense Support
    url: https://typesense.org/support
  termsOfService: https://typesense.org/terms
servers:
- url: https://cloud.typesense.org/api/v1
  description: Typesense Cloud API
security:
- cloudApiKey: []
tags:
- name: Server Configuration Parameters
  description: Manage Typesense Server configuration parameters for cloud clusters.
paths:
  /clusters/{clusterId}/typesense-server-configuration-parameters:
    parameters:
    - $ref: '#/components/parameters/clusterId'
    get:
      operationId: getServerConfigurationParameters
      summary: Get Server Configuration Parameters
      description: Retrieves the current Typesense Server configuration parameters for a cloud cluster. Changes to parameters take effect when the server is restarted.
      tags:
      - Server Configuration Parameters
      responses:
        '200':
          description: Server configuration parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerConfigurationParameters'
        '401':
          description: Unauthorized
        '404':
          description: Cluster not found
    patch:
      operationId: updateServerConfigurationParameters
      summary: Update Server Configuration Parameters
      description: Updates Typesense Server configuration parameters for a cloud cluster. The server must be restarted for changes to take effect. Use the configuration changes endpoint to schedule a restart.
      tags:
      - Server Configuration Parameters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerConfigurationParameters'
      responses:
        '200':
          description: Parameters updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerConfigurationParameters'
        '400':
          description: Bad request - invalid parameter values
        '401':
          description: Unauthorized
        '404':
          description: Cluster not found
components:
  parameters:
    clusterId:
      name: clusterId
      in: path
      required: true
      description: Unique identifier of the cluster.
      schema:
        type: string
  schemas:
    ServerConfigurationParameters:
      type: object
      description: Typesense Server runtime configuration parameters. Changes take effect after a server restart.
      additionalProperties: true
      properties:
        cache-num-entries:
          type: integer
          description: Number of entries in the LRU cache.
        thread-pool-size:
          type: integer
          description: Size of the thread pool for handling requests.
        log-slow-requests-time-ms:
          type: integer
          description: Threshold in milliseconds for logging slow requests.
  securitySchemes:
    cloudApiKey:
      type: apiKey
      in: header
      name: X-TYPESENSE-CLOUD-MANAGEMENT-API-KEY
      description: Cloud management API key for authenticating requests to the Typesense Cloud Management API.
externalDocs:
  description: Typesense Cloud Management API Documentation
  url: https://typesense.org/docs/cloud-management-api/v1/cluster-management.html