---
title: "Rename a fleet"
method: PATCH
path: "/api/{org_id}/fleet/fleets/{fleet_id}"
tags: ["Fleet"]
---

# Rename a fleet

`PATCH /api/{org_id}/fleet/fleets/{fleet_id}`

## Request

- Base URL: `https://api.openobserve.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openobserve.ai/api/{org_id}/fleet/fleets/{fleet_id}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/fleet/fleets/:fleet_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `org_id` string, required
- `fleet_id` string, required

## Request body

- RenameFleetRequest
  - `name` string, required

## Response `200`

Renamed

- Fleet
  - `id` string, required
  - `name` string, required
  - `settings` FleetSettings, required: Per-fleet overrides; `None` inherits the organization default.
    - `gate` GateSettings: The verification gate: wait `observe_secs`, then measure over `window_secs`.
      - `observe_secs` integer, required
      - `pass_percent` integer, required
      - `window_secs` integer, required
    - `heartbeat_interval_secs` integer, nullable
    - `offline_heartbeats` integer, nullable: A collector is offline after this many missed heartbeats.
    - `offline_ratio_percent` integer, nullable
    - `phase_timeout_secs` integer, nullable
    - `retention_days` integer, nullable: Offline collectors are removed after this many days; 0 keeps them forever.
  - `state` FleetState
    - `at_desired` integer, required: Collectors whose assignment is the desired version.
    - `collectors` integer, required
    - `desired` FleetVersion: A configuration version a fleet runs or should run.
      - `config` string, required
      - `version` integer, required
    - `online` integer, required
    - `rollout` FleetRollout: A fleet's latest rollout.
      - `id` string, required
      - `status` 'scheduled' | 'waiting' | 'in_progress' | 'halted' | 'completed' | 'superseded' | 'rolled_back', required
    - `stable` FleetVersion: A configuration version a fleet runs or should run.
      - `config` string, required
      - `version` integer, required

## Other responses

- `400`: Invalid, or the default fleet
- `403`: Forbidden
- `404`: Not found
- `409`: Name exists

---

[API](https://skmtc.dev/openobserve/apis/openobserve-api-http.md) - [All operations](https://skmtc.dev/openobserve/apis/openobserve-api-http/llms.txt) - [OpenAPI document](https://skmtc.dev/openobserve/apis/openobserve-api-http/revisions/0529b8a10252?raw)