How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Typesense Configuration Changes API

Schedule, retrieve, list, and cancel configuration changes to running clusters such as memory upgrades, version changes, and HA toggles.

Typesense Configuration Changes API is one of 6 APIs that Typesense publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration Changes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://cloud.typesense.org/api/v1.

4 operations 2 paths 2 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
http://localhost:8108
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Typesense Configuration Changes API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-TYPESENSE-CLOUD-MANAGEMENT-API-KEY (cloudApiKey). By default, every request must be authenticated.

  • cloudApiKey — Cloud management API key for authenticating requests to the Typesense Cloud Management API.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration Changes 4

Schedule, retrieve, list, and cancel configuration changes to running clusters such as memory upgrades, version changes, and HA toggles.

POST
/clusters/{clusterId}/configuration-changes
Schedule A Configuration Change
createConfigurationChange 1 param body → 201400401404
GET
/clusters/{clusterId}/configuration-changes
List Configuration Changes
listConfigurationChanges 2 params → 200401404
GET
/clusters/{clusterId}/configuration-changes/{changeId}
Retrieve A Configuration Change
getConfigurationChange 2 params → 200401404
PATCH
/clusters/{clusterId}/configuration-changes/{changeId}
Cancel A Configuration Change
updateConfigurationChange 2 params body → 200400401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ConfigurationChange (8 properties), ConfigurationChangeCreateSchema (8 properties). Each schema is shown below with its type and property counts.

ConfigurationChangeCreateSchema
object
8 properties
ConfigurationChange
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

typesense-configuration-changes-api-openapi.yml Raw ↑

Other APIs Typesense publishes across the network.

Typesense Analytics Events API
Typesense Analytics Operations API
Typesense Analytics Rules API
Typesense Cluster Management API
Typesense Server Configuration Parameters API
Where this information came from

This is an independent, third-party profile of Typesense Configuration Changes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.