Bulk change agent privilege level

Base URL: https://{kibana_url}

POST /api/fleet/agents/bulk_privilege_level_change
POST /s/{space_id}/api/fleet/agents/bulk_privilege_level_change

Auth

Change multiple agents' privilege level to unprivileged.

Required authorization

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.

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
user_info object

Responses

OK: A successful request.

application/json

Any of:

actionId string required

A bad request.

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/bulk_privilege_level_change
{
  "agents": "agent",
  "user_info": {
    "groupname": "groupname",
    "password": "password",
    "username": "username"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_privilege_level_change" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": "agent",
    "user_info": {
      "groupname": "groupname",
      "password": "password",
      "username": "username"
    }
  }'