Skip to main content
GET
/
network
cURL
curl \
  -X GET 'MEILISEARCH_URL/network'
{
  "self": "ms-0",
  "remotes": {
    "ms-0": {
      "url": "http://localhost:7700",
      "searchApiKey": null,
      "writeApiKey": null
    },
    "ms-1": {
      "url": "http://localhost:7701",
      "searchApiKey": "foo",
      "writeApiKey": "bar"
    },
    "ms-2": {
      "url": "http://localhost:7702",
      "searchApiKey": "bar",
      "writeApiKey": "foo"
    }
  }
}

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:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

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

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Response

Known nodes are returned.

Network topology configuration for distributed Meilisearch

​
remotes
object

Map of remote instance names to their configurations

Example:
{
  "ms-00": { "url": "http://localhost:7700" },
  "ms-01": { "url": "http://localhost:7701" }
}
​
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

Previous remote configurations (for rollback)

Example:
{
  "ms-00": { "url": "http://localhost:7700" },
  "ms-01": { "url": "http://localhost:7701" }
}