Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Update organization preview feature

PATCH/v1/organizations/{organizationId}/previews/{previewId}
API playground

Disclaimer: This beta endpoint is evolving; the API contract may change.

Switches a preview feature on or off for the organization. Use an ID returned by the list endpoint; an unknown ID returns 404. Only previews offered to the organization can be switched on, otherwise the request returns 403; switching off is always allowed.

Permission

The API key must have the control-plane:organization:manage permission.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid
  • previewIdstringrequired

    ID of the requested preview feature.

Request bodyJSON

  • enabledbooleanrequired

    Whether the preview feature should be on.

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    6 properties
    • idstringrequired

      Stable identifier of the preview feature.

      Example: "preview-id"
    • namestringrequired

      Name of the preview feature.

    • descriptionstringrequired

      What the preview feature does.

    • docsUrlstringrequired

      Link to the documentation of the preview feature.

      Example: "https://clickhouse.com/docs"
    • enabledbooleanrequired

      Whether the preview feature is on for the organization.

    • canTogglebooleanrequired

      Whether the caller may switch the preview feature on or off.