Migrate multiple agents

Base URL: https://{kibana_url}

POST /api/fleet/agents/bulk_migrate

Auth

Bulk migrate agents to another cluster.

Required privileges

Privileges fleet-agents-all

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

agents union string[] | string required
batchSize number
dryRun boolean
enrollment_token string required
settings object
uri string · format: uri required

Responses

Successful response

application/json

Any of:

actionId string required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Migrate multiple agents to another cluster

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_migrate
{
  "agents": [
    "agent-id-1",
    "agent-id-2"
  ],
  "enrollment_token": "enrollment-token-value",
  "settings": {
    "retry_max": 5
  },
  "uri": "https://fleet-server.example.com:8220"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_migrate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": [
      "agent-id-1",
      "agent-id-2"
    ],
    "enrollment_token": "enrollment-token-value",
    "settings": {
      "retry_max": 5
    },
    "uri": "https://fleet-server.example.com:8220"
  }'

Generated from the API spec

Response

Bulk agent migration initiated

{
  "actionId": "action-id-1"
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

Required privileges

Header parameters

Request body { }

Responses

Request body