---
type: api
title: Bulk upgrade agents
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v8/operation/operation-bulk-upgrade-agents
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v8/operation/operation-bulk-upgrade-agents
products:
  - Kibana
---

# Bulk upgrade agents

- Server: `https://{kibana_url}`

## Paths

- `POST` `/api/fleet/agents/bulk_upgrade`
- `POST` `/s/{space_id}/api/fleet/agents/bulk_upgrade`

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

## 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>`

## Header parameters

- `kbn-xsrf` (string) — required
  Kibana's anti Cross-Site Request Forgery token. Can be any string value.

## Request body

`application/json`

- `agents` (union string | string[]) — required
- `force` (boolean) — optional
  Force upgrade, skipping validation (should be used with caution)
- `rollout_duration_seconds` (number) — optional
  rolling upgrade window duration in seconds
- `skipRateLimitCheck` (boolean) — optional
  Skip rate limit check for upgrade
- `source_uri` (string) — optional
  alternative upgrade binary download url
- `start_time` (string) — optional
  start time of upgrade in ISO 8601 format
- `version` (string) — required
  version to upgrade to

## Responses

#### `200`

OK

`application/json`

- `actionId` (string)
#### `400`

Generic Error

`application/json`

- `error` (string)
- `message` (string)
- `statusCode` (number)
## Code examples

#### Console

```console
POST kbn:/api/fleet/agents/bulk_upgrade
{
  "agents": "string",
  "version": "string"
}
```

#### curl

```curl
curl -X POST "${KIBANA_URL}/api/fleet/agents/bulk_upgrade" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agents": "string",
    "version": "string"
  }'
```

