Update an agent by ID

Server: https://{kibana_url}

PUT /api/fleet/agents/{agentId}

Api key auth Basic auth

Update an agent by ID.

[Required authorization] Route required privileges: fleet-agents-all.

Path Parameters

agentId string required: The agent ID

Request

Responses

Successful response

application/json

Bad Request

application/json

404

Not Found

application/json

Examples

Update agent tags

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /api/fleet/agents/{agentId}
{
  "tags": [
    "production",
    "linux"
  ]
}

curl Shell

curl -X PUT "https://{kibana_url}/api/fleet/agents/{agentId}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": [
    "production",
    "linux"
  ]
}'

Response

{
  "item": {
    "active": true,
    "enrolled_at": "2024-01-01T00:00:00.000Z",
    "id": "agent-id-1",
    "policy_id": "agent-policy-id-1",
    "policy_revision": 1,
    "status": "online",
    "tags": [
      "production",
      "linux"
    ],
    "type": "PERMANENT",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

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

{
  "error": "Not Found",
  "message": "Agent agent-id-1 not found",
  "statusCode": 404
}

Path Parameters

Request { tags , user_provided_metadata , }

Responses

Request