Network control

Send messages to control the progress of a network topology change task.

The route is mostly used internally when sending a PATCH to the network, but is accessible for manual control as well.

POST /network/control

cURL

cURL

curl \
  -X POST 'MEILISEARCH_URL/network/control' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "origin": {
      "remoteName": "ms-00",
      "taskUid": 42,
      "networkVersion": "0195e7a8-9c0d-7b3a-8f2e-123456789abc"
    },
    "message": {
      "type": "exportNoIndexForRemote",
      "remote": "ms-01"
    }
  }'

import requests

url = "http://localhost:7700/network/control"

payload = {
    "origin": {
        "remoteName": "<string>",
        "taskUid": 1,
        "networkVersion": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "message": {
        "remote": "<string>",
        "type": "exportNoIndexForRemote"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    origin: {
      remoteName: '<string>',
      taskUid: 1,
      networkVersion: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    },
    message: {remote: '<string>', type: 'exportNoIndexForRemote'}
  })
};

fetch('http://localhost:7700/network/control', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7700",
  CURLOPT_URL => "http://localhost:7700/network/control",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'origin' => [
        'remoteName' => '<string>',
        'taskUid' => 1,
        'networkVersion' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'message' => [
        'remote' => '<string>',
        'type' => 'exportNoIndexForRemote'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:7700/network/control"

	payload := strings.NewReader("{\n  \"origin\": {\n    \"remoteName\": \"<string>\",\n    \"taskUid\": 1,\n    \"networkVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"message\": {\n    \"remote\": \"<string>\",\n    \"type\": \"exportNoIndexForRemote\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:7700/network/control")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"origin\": {\n    \"remoteName\": \"<string>\",\n    \"taskUid\": 1,\n    \"networkVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"message\": {\n    \"remote\": \"<string>\",\n    \"type\": \"exportNoIndexForRemote\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:7700/network/control")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"origin\": {\n    \"remoteName\": \"<string>\",\n    \"taskUid\": 1,\n    \"networkVersion\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"message\": {\n    \"remote\": \"<string>\",\n    \"type\": \"exportNoIndexForRemote\"\n  }\n}"

response = http.request(request)
puts response.read_body

401

{
  "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

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'
});

Body

application/json

origin · object · required

The origin of this message

Get it in the details of the network topology change task that is currently processing.

Show child attributes

message · object · required

Message to send to control the network topology change task.

Option 1

Option 2

Option 3

Show child attributes

Response

200

Empty response.