curl \
-X GET 'MEILISEARCH_URL/network' \
-H 'Authorization: Bearer API_KEY'client.getNetwork()$client->getNetwork();client.get_all_networks()client.GetNetwork();let network = client
.get_network_state()
.await
.unwrap();HttpResponse<String> response = Unirest.get("http://localhost:7700/network")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7700/network")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Get network topology
Return the list of Meilisearch instances currently known to this node (self and remotes).
curl \
-X GET 'MEILISEARCH_URL/network' \
-H 'Authorization: Bearer API_KEY'client.getNetwork()$client->getNetwork();client.get_all_networks()client.GetNetwork();let network = client
.get_network_state()
.await
.unwrap();HttpResponse<String> response = Unirest.get("http://localhost:7700/network")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7700/network")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Authorizations
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
Map of remote instance names to their configurations
- Pass
nullas 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.
Show child attributes
Show child attributes
{
"ms-00": { "url": "http://localhost:7700" },
"ms-01": { "url": "http://localhost:7701" }
}
Map of shard names to their configurations.
- Pass
nullas 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.
Show child attributes
Show child attributes
{
"shard-00": { "remotes": ["ms-00", "ms-01"] }
}
Previous shard configurations
This field should not be passed by end-users. It is used in internal communications between Meilisearch instances
Show child attributes
Show child attributes
{
"shard-00": { "remotes": ["ms-00", "ms-01"] }
}
Name of this instance in the network
"ms-00"
Name of the leader instance in the network
"ms-00"
Previous remote configurations
This field should not be passed by end-users. It is used in internal communications between Meilisearch instances
Show child attributes
Show child attributes
{
"ms-00": { "url": "http://localhost:7700" },
"ms-01": { "url": "http://localhost:7701" }
}
Was this page helpful?