Control Plane Roles

Update role

Update a Redpanda Cloud role.

patch/v1/roles/{id}

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/roles/{id}
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Path parameters

idstring required

Request body

update_maskstring

Example request

{
  "role": {
    "description": "Billing Admins have access to billing information.",
    "name": "billing-admin"
  }
}

Response

Ok

Example response

{
  "role": {
    "description": "Billing Admins have access to billing information.",
    "name": "billing_admin"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.