Components

Update a component

Changed on

Set or clear a component's description. Unlike registration, which never lets a key overwrite a description, this is an explicit edit by a person with settings write access or by a secret key (for example Terraform). A merged component's description is read-only.

patch/components/{componentId}

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/components/{componentId}
  • Auth: none declared

Path parameters

componentIdstring uuid required

Component ID to update.

Request body

descriptionstring nullable required

The component's description, or null to clear it.

Response

OK

Changes