Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 59 additions & 24 deletions admin/admin-v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -506,9 +506,18 @@ components:
redpanda.core.admin.v2.AuthenticationConfiguration:
additionalProperties: false
description: |-
Authentication config. Currently only supporting SASL/SCRAM,
however made as a oneof for expansion
Authentication config. Supports:
* SASL/SCRAM
* SASL/PLAIN
oneOf:
- properties:
plainConfiguration:
$ref: "#/components/schemas/redpanda.core.admin.v2.PlainConfig"
description: SASL/PLAIN configuration
title: plain_configuration
required:
- plainConfiguration
title: plain_configuration
- properties:
scramConfiguration:
$ref: "#/components/schemas/redpanda.core.admin.v2.ScramConfig"
Expand Down Expand Up @@ -1146,8 +1155,36 @@ components:
- PATTERN_TYPE_UNSPECIFIED
- PATTERN_TYPE_LITERAL
- PATTERN_TYPE_PREFIX
- PATTERN_TYPE_PREFIXED
title: PatternType
type: string
redpanda.core.admin.v2.PlainConfig:
additionalProperties: false
description: PLAIN settings
properties:
password:
description: Password
title: password
type: string
writeOnly: true
passwordSet:
description: Indicates that the password has been set
readOnly: true
title: password_set
type: boolean
passwordSetAt:
$ref: "#/components/schemas/google.protobuf.Timestamp"
description: |-
Timestamp of when the password was last set - only valid if password_set
is true
readOnly: true
title: password_set_at
username:
description: PLAIN username
title: username
type: string
title: PlainConfig
type: object
redpanda.core.admin.v2.RPCRoute:
additionalProperties: false
description: A route in the Admin API RPC server.
Expand Down Expand Up @@ -1849,6 +1886,7 @@ components:
- ACL_PATTERN_ANY
- ACL_PATTERN_LITERAL
- ACL_PATTERN_PREFIXED
- ACL_PATTERN_PREFIX
- ACL_PATTERN_MATCH
title: ACLPattern
type: string
Expand Down Expand Up @@ -1958,14 +1996,14 @@ info:
title: Redpanda Admin API
version: v2.0.0
x-admin-api-major: v2.0.0
x-generated-at: 2025-11-13T21:09:09.434Z
x-generated-at: 2025-12-12T04:54:23.532Z
x-generator: redpanda-docs-openapi-bundler
x-redpanda-core-version: kb/proto/docs/openapi-summaries
x-redpanda-core-version: v25.3.2
openapi: 3.1.0
paths:
/redpanda.core.admin.v2.BrokerService/GetBroker:
post:
description: Returns information about a single broker in the cluster.
description: GetBroker returns information about a single broker in the cluster.
operationId: redpanda.core.admin.v2.BrokerService.GetBroker
parameters:
- in: header
Expand Down Expand Up @@ -1996,12 +2034,12 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: GetBroker
summary: GetBroker returns information about a single broker in the cluster.
tags:
- BrokerService
/redpanda.core.admin.v2.BrokerService/ListBrokers:
post:
description: Returns information about all brokers in the cluster.
description: ListBrokers returns information about all brokers in the cluster.
operationId: redpanda.core.admin.v2.BrokerService.ListBrokers
parameters:
- in: header
Expand Down Expand Up @@ -2032,12 +2070,14 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: ListBrokers
summary: ListBrokers returns information about all brokers in the cluster.
tags:
- BrokerService
/redpanda.core.admin.v2.ClusterService/ListKafkaConnections:
post:
description: Returns information about the cluster's Kafka connections, collected and ordered across all brokers.
description: |-
ListKafkaConnections returns information about the cluster's Kafka
connections, collected and ordered across all brokers.
operationId: redpanda.core.admin.v2.ClusterService.ListKafkaConnections
parameters:
- in: header
Expand Down Expand Up @@ -2068,12 +2108,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: ListKafkaConnections
summary: ListKafkaConnections returns information about the cluster's Kafka connections, collected and ordered across all brokers.
tags:
- ClusterService
/redpanda.core.admin.v2.ShadowLinkService/CreateShadowLink:
post:
description: Creates a new shadow link between clusters.
operationId: redpanda.core.admin.v2.ShadowLinkService.CreateShadowLink
parameters:
- in: header
Expand Down Expand Up @@ -2109,7 +2148,6 @@ paths:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink:
post:
description: Deletes an existing shadow link.
operationId: redpanda.core.admin.v2.ShadowLinkService.DeleteShadowLink
parameters:
- in: header
Expand Down Expand Up @@ -2145,7 +2183,7 @@ paths:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/FailOver:
post:
description: Fails over a shadow link or a single shadow topic for disaster recovery.
description: Fails over a shadow link or a single shadow topic
operationId: redpanda.core.admin.v2.ShadowLinkService.FailOver
parameters:
- in: header
Expand Down Expand Up @@ -2176,12 +2214,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: FailOver
summary: Fails over a shadow link or a single shadow topic
tags:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/GetShadowLink:
post:
description: Gets information about a specific shadow link.
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowLink
parameters:
- in: header
Expand Down Expand Up @@ -2218,9 +2255,9 @@ paths:
/redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic:
post:
description: |-
Returns information about a shadow topic on a shadow link.
A shadow topic is a resource created automatically by a shadow link. The
shadow topic 'shadows' a topic on a source cluster, mirroring the data
This operation returns information about a Shadow Topic on a Shadow Link.
A Shadow Topic is a resource created automatically by a Shadow Link. The
Shadow Topic 'shadows' a topic on a source cluster, mirroring the data
and properties of that topic.
operationId: redpanda.core.admin.v2.ShadowLinkService.GetShadowTopic
parameters:
Expand Down Expand Up @@ -2252,12 +2289,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: GetShadowTopic
summary: This operation returns information about a Shadow Topic on a Shadow Link. A Shadow Topic is a resource created automatically by a Shadow Link. The Shadow Topic 'shadows' a topic on a source cluster, mirroring the data and properties of that topic.
tags:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/ListShadowLinks:
post:
description: Lists all shadow links in the cluster.
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowLinks
parameters:
- in: header
Expand Down Expand Up @@ -2294,8 +2330,8 @@ paths:
/redpanda.core.admin.v2.ShadowLinkService/ListShadowTopics:
post:
description: |-
Returns a list of all shadow topics on a shadow link and
their status.
This operation returns a list of all Shadow Topics on a Shadow Link and
their status
operationId: redpanda.core.admin.v2.ShadowLinkService.ListShadowTopics
parameters:
- in: header
Expand Down Expand Up @@ -2326,12 +2362,11 @@ paths:
schema:
$ref: "#/components/schemas/connect.error"
description: Error
summary: ListShadowTopics
summary: This operation returns a list of all Shadow Topics on a Shadow Link and their status
tags:
- ShadowLinkService
/redpanda.core.admin.v2.ShadowLinkService/UpdateShadowLink:
post:
description: Updates an existing shadow link configuration.
operationId: redpanda.core.admin.v2.ShadowLinkService.UpdateShadowLink
parameters:
- in: header
Expand Down