REredpanda-data
Shadow Box

Update shadow box settings

Changed on

Update the settings that the next box uses. A change also applies to a box that is in place.

patch/v1/shadow-box/settings

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Request body

expected_revisionstring int64 nullable

If set, the request fails unless the box is still at this revision. Use the revision from GetShadowBoxStatus or an earlier response. Set it to fail if the box changed since you read it.

update_maskstring

The settings to change. Settings it doesn't name keep their saved values. Naming read_policy replaces the whole read policy, and naming read_policy.exempt_principals adds names to the list. If empty, every setting is replaced.

Response

OK

Changes