Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Update a saved query

PUT/v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}
API playground

Updates a saved query.

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
  • serviceIdstringrequired

    ID of the requested service.

    format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
  • queryIdstringrequired

    ID of the requested saved query.

    format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

Request bodyJSON

  • namestringrequired

    Name of the saved query.

    minLength: 1
  • sqlstringrequired

    Saved SQL query.

    maxLength: 4194304
  • databasestringrequired

    Database used by the saved query.

  • parametersoptionalmap ofstring

    Default query parameters.

    Default: {}

Response

JSON

200

The saved query was updated.

JSON
  • statusintegerrequired

    HTTP status code.

    Example: 200
  • requestIdstringrequired

    Unique id assigned to every request. UUIDv4

    format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
  • resultobjectrequired
    5 properties
    • idstringrequired

      Unique ID of the saved query.

      format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
    • namestringrequired

      Name of the saved query.

    • sqlstringrequired

      Saved SQL query.

      maxLength: 4194304
    • databasestringrequired

      Database used by the saved query.

    • parametersmap ofstringrequired

      Query parameters.