Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

Response

Known nodes are returned.

Network topology configuration for distributed Meilisearch

remotes
object | null

Map of remote instance names to their configurations

  • Pass null as a value for a remote to remove it from the configuration.
  • Removing a remote will also remove it from all shards.
  • Remotes that don't appear in this list will be unmodified by the network call.
Example:
shards
object | null

Map of shard names to their configurations.

  • Pass null as a value for a shard to remove it from the configuration.
  • Shards that don't appear in this list will be unmodified by the network call.
Example:
previousShards
object | null

Previous shard configurations

This field should not be passed by end-users. It is used in internal communications between Meilisearch instances

Example:
self
string | null

Name of this instance in the network

Example:

"ms-00"

leader
string | null

Name of the leader instance in the network

Example:

"ms-00"

previousRemotes
object | null

Previous remote configurations

This field should not be passed by end-users. It is used in internal communications between Meilisearch instances

Example: