Skip to content

[Internal]: Fix incorrect elastic-api-version value in Fleet agent migration guide #7152

Description

@teresaromero

Description

Two pages in the Fleet migration documentation instruct customers to pass --header 'elastic-api-version: 1' when calling POST /internal/fleet/reset_preconfigured_agent_policies/policy-elastic-agent-on-cloud. This value is wrong and causes a 400 Bad Request error.

The value 1 is the Kibana-internal versioning string. This endpoint is registered as a public versioned route — its only valid version string is 2023-10-31.

Files affected:

  1. reference/fleet/migrate-elastic-agent.md — line 156

    • Current: --header 'elastic-api-version: 1'
    • Correct: --header 'elastic-api-version: 2023-10-31'
  2. troubleshoot/ingest/fleet/common-problems.md — line 1031

    • Current: --header 'elastic-api-version: 1'
    • Correct: --header 'elastic-api-version: 2023-10-31'

Resources

  • SDH support ticket: elastic/sdh-beats#7315 — customer hit this error following the migration guide on Elastic Agent 9.4.2
  • Kibana route definition confirming the correct version: x-pack/platform/plugins/shared/fleet/common/constants/routes.ts:286API_VERSIONS.public.v1 = '2023-10-31'
  • Route registration: x-pack/platform/plugins/shared/fleet/server/routes/preconfiguration/index.ts:39,65

Which deployment methods does this change impact?

Elastic Cloud Hosted only — the policy policy-elastic-agent-on-cloud is specific to ECH deployments.

What Elastic Stack release is this request related to?

9.4 (customer version at time of report), but the fix applies to all supported versions where this guide exists.

Collaboration model

The product or engineering team will create the first draft — this is a one-line fix in two locations, no new content needed.

Point of contact

Main contact: @teresaromero

Stakeholders: @elastic/fleet

Metadata

Metadata

Assignees

Labels

Team:SKIIssues owned by the SKI Docs Team

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions