Update BYOC infrastructure customer-authorized access

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.

PATCH

organizations

{organizationId}

byocInfrastructure

{byocInfrastructureId}

customerAuthorizedAccess

Update BYOC infrastructure customer-authorized access

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "window",
  "startTimestamp": "2023-11-07T05:31:56Z",
  "durationSeconds": 14400
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess"

payload = {
    "mode": "window",
    "startTimestamp": "2023-11-07T05:31:56Z",
    "durationSeconds": 14400
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({mode: 'window', startTimestamp: '2023-11-07T05:31:56Z', durationSeconds: 14400})
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => 'window',
    'startTimestamp' => '2023-11-07T05:31:56Z',
    'durationSeconds' => 14400
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess"

	payload := strings.NewReader("{\n  \"mode\": \"window\",\n  \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n  \"durationSeconds\": 14400\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"window\",\n  \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n  \"durationSeconds\": 14400\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"window\",\n  \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n  \"durationSeconds\": 14400\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "mode": "window",
    "allowed": true,
    "startTimestamp": "2023-11-07T05:31:56Z",
    "durationSeconds": 14400,
    "windowEndTimestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta 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

Authorization

string

header

required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId

string<uuid>

required

ID of the organization that owns the BYOC infrastructure.

byocInfrastructureId

string<uuid>

required

ID of the BYOC infrastructure.

Body

application/json

mode

string

required

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"

startTimestamp

string<date-time>

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

durationSeconds

integer

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

Example:

14400

Response

Successful response

status

number

HTTP status code.

Example:

200

requestId

string<uuid>

Unique id assigned to every request. UUIDv4

result

object

Show child attributes

Update BYOC infrastructure customer-authorized access

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "window",
  "startTimestamp": "2023-11-07T05:31:56Z",
  "durationSeconds": 14400
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess"

payload = {
    "mode": "window",
    "startTimestamp": "2023-11-07T05:31:56Z",
    "durationSeconds": 14400
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({mode: 'window', startTimestamp: '2023-11-07T05:31:56Z', durationSeconds: 14400})
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'mode' => 'window',
    'startTimestamp' => '2023-11-07T05:31:56Z',
    'durationSeconds' => 14400
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess"

	payload := strings.NewReader("{\n  \"mode\": \"window\",\n  \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n  \"durationSeconds\": 14400\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"window\",\n  \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n  \"durationSeconds\": 14400\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/customerAuthorizedAccess")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"window\",\n  \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n  \"durationSeconds\": 14400\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "mode": "window",
    "allowed": true,
    "startTimestamp": "2023-11-07T05:31:56Z",
    "durationSeconds": 14400,
    "windowEndTimestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Get started

Services and infrastructure

Bring Your Own Cloud

Data and integrations

Connect and query

Access management

Security and compliance

Monitoring and backups

AI tools and agents

Cloud API

Billing

Support

ClickHouse Private

Update BYOC infrastructure customer-authorized access

Permission

Authorizations

Path Parameters

Body

Response

​Permission

Authorizations

Path Parameters

Body

Response

Permission