For the complete documentation index, see llms.txt. Component-specific: api-full.txt

Redpanda
Redpanda
Documentation
Labs
Labs
Sign in
New. Sign in to unlock the docs AI agent.
Free with Redpanda Cloud

Sign in to unlock the docs AI agent

Your personal assistant for Redpanda docs. Sign in and it can:

  • Pick up where you left off Every conversation is saved and synced across your devices.
  • Find answers, not just pages It searches the docs and opens the exact page you need.
  • Write Bloblang with confidence Draft mappings and verify they work before you run them.
  • Help shape the docs Send feedback to the docs team without leaving the page.
Continue

No account yet? Create a free account

When you sign in, we collect your verified work email. We also record which pages you view, what you search for, and the questions you ask the AI, and use this to attribute documentation usage to your organization and to follow up about Redpanda products, including through our sales team. See our Privacy Policy for details.

Signed in
Sign out
Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Share feedback
Admin API logo
v1
  • v1 default
  • v2

Topics

  • Introduction

Endpoints

  • Authentication
    • Verify identity of current user and resolve to a principal GET
    • Reload the keys from the identity provider POST
    • Reload the keys from the identity provider and disconnect clients POST
  • Clusters
    • Get brokers' configurations GET
    • Get cluster configuration GET
    • Update cluster configuration PUT
    • Get cluster configuration schema GET
    • Get cluster configuration status GET
    • Get cluster ready status GET
    • Get cluster view GET
    • Get cluster health overview GET
    • Get cluster UUID GET
  • Brokers
    • Get all brokers GET
    • Get a broker GET
    • Cancel partition movement POST
    • Get broker decommission status GET
    • Decommission broker PUT
    • Enter broker maintenance mode PUT
    • Exit broker maintenance mode DELETE
    • Recommission broker PUT
    • Check broker pre-restart GET
    • Check broker post-restart GET
    • Get maintenance status GET
    • Start maintenance PUT
    • Stop maintenance DELETE
  • Partitions
    • Transfer Raft group leadership POST
    • List partitions GET
    • Get local partitions GET
    • Get partitions with lost majority GET
    • Force recover partitions POST
    • Rebalance partitions POST
    • Rebalance partitions among broker cores POST
    • List ongoing partition reconfigurations GET
    • Get topic partition information GET
    • Get detailed partition information GET
    • Cancel partition reconfiguration POST
    • Update partition replicas POST
    • Update partition replica core POST
    • Get partition transactions GET
    • Transfer leadership POST
    • Cancel all partition reconfigurations POST
    • Get cluster-level metadata for all partitions in cluster GET
    • Get cluster-level metadata for all partitions in topic GET
    • Disable/enable all partitions of a topic POST
    • Disable/enable a single partition POST
    • Get partition balancer status GET
    • Force update replicas POST
  • Tiered Storage
    • Query automated topic recovery status GET
    • Start topic scan and recovery POST
    • Get cloud storage status for a partition GET
    • Get in-memory partition manifest GET
    • Get topic lifecycle markers GET
    • Drop topic lifecycle marker DELETE
    • Sync local state POST
    • Get cluster recovery status GET
    • Initialize cluster recovery POST
    • Trim Tiered Storage cache POST
    • Get cloud storage anomalies for a partition GET
    • Reset metadata from cloud POST
    • Reset scrubbing metadata POST
  • Mount and unmount topics
    • List mountable topics GET
    • Mount a topic to a cluster POST
    • Unmount topics from a cluster POST
    • List all available migrations GET
    • Create migration PUT
    • Get migration state GET
    • Execute migration action POST
    • Delete migration DELETE
  • Transactions
    • Mark transaction expired POST
    • Get transaction coordinator GET
    • Delete partition from transaction POST
    • List all transactions GET
  • Users
    • List users GET
    • Create user POST
    • Update user PUT
    • Delete user DELETE
    • List role assignments for a user GET
  • Roles
    • List roles GET
    • Create a role POST
    • Get the specified role GET
    • Remove a role by name DELETE
    • List members assigned a given role GET
    • Update role membership POST
  • Licenses and Features
    • List available features GET
    • Get license and feature status GET
    • Get license details GET
    • Upload license PUT
    • Activate feature PUT
  • Logging
    • Get loggers GET
    • Set log level PUT
  • Debugging
    • Get status of debug bundle collection GET
    • Start a debug bundle collection POST
    • Cancel a debug bundle process DELETE
    • Download a debug bundle file GET
    • Delete a debug bundle file DELETE
    • Start cluster self-test POST
    • Get cluster self-test status GET
    • Stop cluster self-test POST
    • Get samples from CPU profiler GET
    • Restart service PUT
  • Security
    • Get security report GET
  • Unstable APIs
    • Abort partition reconfiguration POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Share feedback
Admin API logo

Tiered Storage

Ask AI
  • View as Markdown
  • Copy as Markdown

Manage Tiered Storage.

Redpanda
© 2026 Redpanda Data, Inc. All rights reserved.
Privacy policy Terms Status Trust Cookie preferences
Redpanda AI
Ask about any doc
AI answers may be imprecise. Always verify in the docs.