Update an agent by ID

Base URL: https://{kibana_url}

PUT /api/fleet/agents/{agentId}

Update an agent by ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

Successful response

application/json

item object required

Bad Request

application/json

404

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Update agent tags

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/fleet/agents/${AGENT_ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": [
      "production",
      "linux"
    ]
  }'

Generated from the API spec

Response

Updated agent details

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

Required authorization

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body