Change Updates

Do not miss any Redpanda APIs Hub changes, ever again

Subscribe to the Redpanda APIs Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Admin API
9 structure changes including:
2 Breaking changes
6 Additions
3 Modifications
Modified 3 Breaking
GET /v1/cloud_storage/status/{topic}/{partition}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • stm_region_size_bytes, archive_size_bytes, stm_region_segment_count, local_log_segment_count, stm_region_start_offset properties Added
GET /v1/cloud_storage/topic_recovery
  • Path went from /v1/cloud_storage/initiate_topic_scan_and_recovery to /v1/cloud_storage/topic_recovery (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • request, state, topic_download_counts properties Added
POST /v1/cloud_storage/topic_recovery
  • Path went from /v1/cloud_storage/initiate_topic_scan_and_recovery to /v1/cloud_storage/topic_recovery (same operationId)
    Breaking
Added 6
GET /v1/cloud_storage/anomalies/{namespace}/{topic}/{partition}
GET /v1/cloud_storage/automated_recovery
POST /v1/cloud_storage/automated_recovery
POST /v1/cloud_storage/cache/trim
POST /v1/cloud_storage/reset_scrubbing_metadata/{namespace}/{topic}/{partition}
POST /v1/cloud_storage/unsafe_reset_metadata_from_cloud/{namespace}/{topic}/{partition}
Cloud Control Plane API
19 structure changes including:
19 Modifications
Modified 19 Breaking
DELETE /v1/clusters/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
DELETE /v1/network/{network_id}/network-peerings/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /v1/networks/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
DELETE /v1/serverless/clusters/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /v1/shadow-links/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
GET /v1/network/{network_id}/network-peerings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • network_peerings property Modified
        • status property Modified
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/network/{network_id}/network-peerings/{id}
  • Response
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/operations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • operations property Modified
        • metadata, response properties Modified
GET /v1/operations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
GET /v1/serverless/clusters
  • Response
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/serverless/clusters/{id}
  • Response
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /v1/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • users property Modified
        • identities property Added
GET /v1/users/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
        • identities property Added
PATCH /v1/shadow-links/{shadow_link.id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
POST /v1/clusters
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
POST /v1/network/{network_peering.network_id}/network-peerings
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /v1/networks
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
POST /v1/serverless/clusters
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
  • default response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /v1/shadow-links
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • metadata, response properties Modified
Cloud Data Plane API
Admin API
5 structure changes including:
5 Modifications
Modified 5
POST /redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink
  • Body
  • application/json content type Modified
    • shadowLink property Modified
      • configurations property Modified
        • clientOptions property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations property Modified
POST /redpanda.core.admin.v2.ShadowLinkService/FailOver
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations property Modified
POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowLink
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations property Modified
POST /redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLinks property Modified
        • configurations property Modified
POST /redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink
  • Body
  • application/json content type Modified
    • shadowLink property Modified
      • configurations property Modified
        • clientOptions property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations property Modified
Cloud Data Plane API
5 structure changes including:
5 Additions
Added 5
GET /v1/shadow-links/{name}
GET /v1/shadow-links/{name}/metrics
GET /v1/shadow-links/{shadow_link_name}/topic
GET /v1/shadow-links/{shadow_link_name}/topic/{topic_name}
POST /v1/shadow-links/{name}/failover
Cloud Control Plane API
10 structure changes including:
5 Additions
5 Modifications
Modified 5
GET /v1/serverless/clusters
  • Response
  • 200 response Modified
    • application/json content type Modified
      • serverless_clusters property Modified
        • tags property Added
GET /v1/serverless/clusters/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tags property Added
PATCH /v1/serverless/clusters/{id}
  • Body
  • application/json content type Modified
    • tags property Added
  • Response
  • 202 response Modified
    • application/json content type Modified
      • tags property Added
POST /v1/clusters
  • Body
  • application/json content type Modified
    • cluster property Modified
      • redpanda_node_count property Added
POST /v1/serverless/clusters
  • Body
  • application/json content type Modified
    • serverless_cluster property Modified
      • tags property Added
Added 5
DELETE /v1/shadow-links/{id}
GET /v1/shadow-links
GET /v1/shadow-links/{id}
PATCH /v1/shadow-links/{shadow_link.id}
POST /v1/shadow-links
Cloud Data Plane API
9 structure changes including:
9 Additions
Added 9
DELETE /v1/redpanda-connect/mcp-servers/{id}
GET /v1/redpanda-connect/mcp-servers
GET /v1/redpanda-connect/mcp-servers/{id}
GET /v1/redpanda-connect/mcp-servers:getConfigSchema
POST /v1/redpanda-connect/mcp-servers
POST /v1/redpanda-connect/mcp-servers/{id}:start
POST /v1/redpanda-connect/mcp-servers/{id}:stop
POST /v1/redpanda-connect/mcp-servers:lint-config
PUT /v1/redpanda-connect/mcp-servers/{id}
Cloud Control Plane API
22 structure changes including:
7 Additions
15 Modifications
Modified 15
POST /v1/serverless/clusters
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
POST /v1/networks
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
POST /v1/network/{network_peering.network_id}/network-peerings
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
POST /v1/clusters
  • Body
  • application/json content type Modified
    • cluster property Modified
      • aws_private_link property Modified
        • supported_regions property Added
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
PATCH /v1/clusters/{cluster.id}
  • Body
  • application/json content type Modified
    • aws_private_link property Modified
      • supported_regions property Added
  • Response
  • 202 response Modified
    • application/json content type Modified
      • aws_private_link property Modified
        • supported_regions property Added
GET /v1/serverless/clusters/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prometheus property Added
GET /v1/serverless/clusters
  • Response
  • 200 response Modified
    • application/json content type Modified
      • serverless_clusters property Modified
        • prometheus property Added
GET /v1/operations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
GET /v1/operations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • operations property Modified
        • response property Modified
GET /v1/clusters/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cluster property Modified
        • aws_private_link property Modified
GET /v1/clusters
  • Response
  • 200 response Modified
    • application/json content type Modified
      • clusters property Modified
        • aws_private_link property Modified
DELETE /v1/serverless/clusters/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
DELETE /v1/networks/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
DELETE /v1/network/{network_id}/network-peerings/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
DELETE /v1/clusters/{id}
  • Response
  • 202 response Modified
    • application/json content type Modified
      • operation property Modified
        • response property Modified
Added 7
POST /v1/roles
PATCH /v1/roles/{id}
GET /v1/serverless/clusters/{id}/prometheus/credentials
GET /v1/roles/{id}
GET /v1/roles
GET /v1/permissions
DELETE /v1/roles/{id}
Cloud Data Plane API
Schema Registry API
1.1.2
1 structure change including:
1 Modification
Modified 1 Breaking
POST /compatibility/subjects/{subject}/versions/{version}
  • Path
  • version path parameter Modified
    • Type went from integer to string
      Breaking
Cloud Control Plane API
7 structure changes including:
5 Additions
2 Modifications
Modified 2 Breaking
GET /v1/serverless/clusters
  • Response
  • 200 response Modified
    • application/json content type Modified
      • serverless_clusters property Modified
        • network, private_link properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • networking_config, private_link_id properties Added
  • Query
  • filter.private_link_id query parameter Added
GET /v1/serverless/clusters/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • network, private_link properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • networking_config, private_link_id properties Added
Added 5
DELETE /v1/network/{network_id}/network-peerings/{id}
GET /v1/network/{network_id}/network-peerings
GET /v1/network/{network_id}/network-peerings/{id}
PATCH /v1/serverless/clusters/{id}
POST /v1/network/{network_peering.network_id}/network-peerings
Cloud Data Plane API
11 structure changes including:
3 Additions
8 Modifications
Modified 8
GET /v1/redpanda-connect/pipelines
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pipelines property Modified
        • service_account property Added
  • Query
  • filter.secret_id query parameter Added
GET /v1/redpanda-connect/pipelines-by-secrets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pipelines_for_secret property Modified
        • pipelines property Modified
GET /v1/redpanda-connect/pipelines-for-secret
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pipelines_for_secret property Modified
        • pipelines property Modified
GET /v1/redpanda-connect/pipelines/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • service_account property Added
POST /v1/redpanda-connect/pipelines
  • Body
  • application/json content type Modified
    • service_account property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • service_account property Added
PUT /v1/redpanda-connect/pipelines/{id}
  • Body
  • application/json content type Modified
    • service_account property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • service_account property Added
PUT /v1/redpanda-connect/pipelines/{id}/start
  • Response
  • 200 response Modified
    • application/json content type Modified
      • service_account property Added
PUT /v1/redpanda-connect/pipelines/{id}/stop
  • Response
  • 200 response Modified
    • application/json content type Modified
      • service_account property Added
Added 3
GET /v1/monitoring/kafka/connections
GET /v1/redpanda-connect/components
GET /v1/secrets/resources
Admin API
1 structure change including:
1 Addition
Added 1
GET /v1/security/report
Admin API
11 structure changes including:
11 Modifications
Modified 11
POST /redpanda.core.admin.v2.BrokerService/GetBroker
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.BrokerService/ListBrokers
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ClusterService/ListKafkaConnections
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/FailOver
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowLink
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/ListShadowTopics
  • Operation is now Added in v25.3
POST /redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink
  • Operation is now Added in v25.3
Admin API
5 structure changes including:
5 Modifications
Modified 5
POST /redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink
  • Body
  • application/json content type Modified
    • shadowLink property Modified
      • configurations property Modified
        • consumerOffsetSyncOptions, securitySyncOptions, topicMetadataSyncOptions properties Modified
      • status property Modified
        • taskStatuses property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations, status properties Modified
POST /redpanda.core.admin.v2.ShadowLinkService/FailOver
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations, status properties Modified
POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowLink
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations, status properties Modified
POST /redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLinks property Modified
        • configurations, status properties Modified
POST /redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink
  • Body
  • application/json content type Modified
    • shadowLink property Modified
      • configurations property Modified
        • consumerOffsetSyncOptions, securitySyncOptions, topicMetadataSyncOptions properties Modified
      • status property Modified
        • taskStatuses property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shadowLink property Modified
        • configurations, status properties Modified
Admin API

New Admin API endpoints for Redpanda v25.3 and later.

Schema Registry API
1.1.1
2 structure changes including:
2 Modifications
Modified 2
PUT /mode
  • Query
  • force query parameter Added
PUT /mode/{subject}
  • Query
  • force query parameter Added
Cloud Control Plane API
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /v1/serverless/clusters
  • Response
  • 200 response Modified
    • application/json content type Modified
      • serverless_clusters property Modified
        • dataplane_api, kafka_api, schema_registry properties Modified
        • console property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • console_private_url, network properties Added
GET /v1/serverless/clusters/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dataplane_api property Modified
        • private_url property Added
      • kafka_api property Modified
        • private_seed_brokers property Added
      • schema_registry property Modified
        • private_url property Added
      • console property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • console_private_url, network properties Added
Cloud Data Plane API
1 structure change including:
1 Modification
Modified 1
PUT /v1/secrets/{id}
  • Body
  • application/json content type Modified
    • secret_data property Modified
      • Property is no longer required
Cloud Data Plane API