Migrate a single agent

Base URL: https://{kibana_url}

POST /api/fleet/agents/{agentId}/migrate
POST /s/{space_id}/api/fleet/agents/{agentId}/migrate

Auth

Migrate a single agent to another cluster.

Required privileges

Privileges fleet-agents-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
agentId string · min length: 0 required: The agent ID

Header parameters

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

Request body

enrollment_token string required
settings object
uri string · format: uri required

Responses

Successful response

application/json

actionId string required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Migrate a single agent to another cluster

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/migrate
{
  "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/${AGENT_ID}/migrate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "enrollment_token": "enrollment-token-value",
    "settings": {
      "retry_max": 5
    },
    "uri": "https://fleet-server.example.com:8220"
  }'

Generated from the API spec

Response

Agent migration initiated

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

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