DeleteShadowLink | Admin API documentation (v2)

DeleteShadowLink Added in v25.3

View as markdown

POST /redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink

Deletes an existing shadow link.

Headers

Connect-Protocol-Version number Required

Define the version of the Connect protocol

Value is 1.
Connect-Timeout-Ms number

Define the timeout, in ms

application/json

Body Required

force boolean

By default, DeleteShadowLink will fail if there are any active Shadow Topics. Set this flag to 'true' if you wish to delete the link while there are active shadow topics.
name string Required

The name of the link to delete

Responses

200 application/json

Success

Response to deleting a shadow link

Additional properties are NOT allowed.
default application/json

Error
Hide response attributes Show response attributes object
- code string
  
  The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
  
  Values are canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, or unauthenticated.
- details array[object]
  
  A list of messages that carry the error details. There is no limit on the number of messages.
  
  Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
  
  Hide details attributes Show details attributes object
  
  debug object
  
  Detailed error information.
  
  Additional properties are allowed.
  
  type string
  
  A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
  
  value string(binary)
  
  The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
- message string
  
  A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

POST /redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink

curl \
 --request POST 'http://localhost:9644/redpanda.core.admin.v2.ShadowLinkService/DeleteShadowLink' \
 --header "Content-Type: application/json" \
 --header "Connect-Protocol-Version: 1" \
 --header "Connect-Timeout-Ms: 42.0" \
 --data '{"force":true,"name":"string"}'

Request examples

# Headers
Connect-Protocol-Version: 1
Connect-Timeout-Ms: 42.0

# Payload
{
  "force": true,
  "name": "string"
}

Response examples (200)

{}

Response examples (default)

{
  "code": "not_found",
  "details": [
    {
      "debug": {},
      "type": "string",
      "value": "@file"
    }
  ],
  "message": "string"
}