Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Update BYOC infrastructure customer-authorized access

PATCH/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess
API playground

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Replaces the customer setting that controls when ClickHouse personnel may access the BYOC infrastructure. Allow access with mode: always, deny it with mode: never, or allow it for a single window with mode: window, startTimestamp and durationSeconds. Returns the stored setting together with the data plane verdict.

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the BYOC infrastructure.

    format: uuid
  • byocInfrastructureIdstringrequired

    ID of the BYOC infrastructure.

    format: uuid

Request bodyJSON

  • modestringrequired

    When ClickHouse personnel may access the infrastructure. Current values: always, never, window. New values may be added over time. always allows access, never denies it, and window allows it during a single time window described by startTimestamp and durationSeconds

    Example: "window"
  • startTimestampoptionalstring

    Start of the access window. ISO-8601. Required when mode is window, not allowed otherwise

    format: date-time
  • durationSecondsoptionalinteger

    Length of the access window in seconds, from 1 to 172800 (48 hours). Required when mode is window, not allowed otherwise

    Example: 14400

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    5 properties
    • modestringrequired

      When ClickHouse personnel may access the infrastructure. Current values: always, never, window. New values may be added over time. When the setting has never been configured this is always, the data plane default

      Example: "window"
    • allowedbooleanrequired

      Whether the data plane currently allows ClickHouse personnel access, evaluated at the time of the request

    • startTimestampoptionalstring

      Start of the access window. ISO-8601. Present only when mode is window

      format: date-time
    • durationSecondsoptionalinteger

      Length of the access window in seconds, counted from startTimestamp. Present only when mode is window

      Example: 14400
    • windowEndTimestampoptionalstring

      End of the current access window. ISO-8601. Present only while access is allowed until a deadline

      format: date-time