Bulk change agent privilege level Technical Preview; added in 9.3.0

POST /api/fleet/agents/bulk_privilege_level_change
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Change multiple agents' privilege level to unprivileged.

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

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • agents array[string] | string Required

    Any of:
    array-1 array[string] string-2 string

    Not more than 10000 elements.

  • batchSize number
  • user_info object

    Additional properties are NOT allowed.

    Hide user_info attributes Show user_info attributes object
    • groupname string
    • password string
    • username string

Responses

  • 200 application/json

    OK: A successful request.

    Hide response attribute Show response attribute object
    • actionId string Required
  • 400 application/json

    A bad request.

    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/agents/bulk_privilege_level_change 
curl \
 --request POST 'https://localhost:5601/api/fleet/agents/bulk_privilege_level_change' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"agents":"agent","user_info":{"password":"password","username":"username","groupname":"groupname"}}'
Request example 
{
  "agents": "agent",
  "user_info": {
    "password": "password",
    "username": "username",
    "groupname": "groupname"
  }
}
Response examples (200) 
{
  "actionId": "actionId"
}
Response examples (400) 
{
  "message": "Bad Request"
}