Actualizar la clave
Actualiza las propiedades de la API key.
PATCH
/
v1
/
organizations
/
{organizationId}
/
keys
/
{keyId}
Actualizar la clave
curl --request PATCH \
--url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
'import requests
url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}"
payload = {
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
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({
expireAt: '2023-11-07T05:31:56Z',
ipAccessList: [{description: '<string>', source: '<string>'}],
name: '<string>',
roles: []
})
};
fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}', 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}/keys/{keyId}",
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([
'expireAt' => '2023-11-07T05:31:56Z',
'ipAccessList' => [
[
'description' => '<string>',
'source' => '<string>'
]
],
'name' => '<string>',
'roles' => [
]
]),
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}/keys/{keyId}"
payload := strings.NewReader("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\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}/keys/{keyId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}")
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 \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}"
response = http.request(request)
puts response.read_body{
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"createdAt": "2023-11-07T05:31:56Z",
"expireAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"keySuffix": "<string>",
"name": "<string>",
"roles": [],
"usedAt": "2023-11-07T05:31:56Z"
},
"status": 200
}{
"error": "<string>",
"status": 400
}Autorizaciones
Usa el ID y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi
Parámetros de ruta
ID de la organización propietaria de la clave.
ID de la clave que se va a actualizar.
Cuerpo
application/json
Marca temporal de vencimiento de la clave. Si es null o está vacía, la clave no vence nunca. ISO-8601.
Lista de direcciones IP autorizadas para acceder a la API con esta clave
Show child attributes
Show child attributes
Nombre de la clave
Lista de roles asignados a la clave. Contiene al menos 1 elemento.
Opciones disponibles:
admin, developer, query_endpoints Estado de la clave: 'enabled', 'disabled'.
Opciones disponibles:
enabled, disabled Última modificación el 12 de junio de 2026
¿Esta página le ayudó?
Anterior
Obtener las métricas de la organizaciónDevuelve métricas de Prometheus de todos los servicios de una organización.
Siguiente
⌘I
Actualizar la clave
curl --request PATCH \
--url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
'import requests
url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}"
payload = {
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
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({
expireAt: '2023-11-07T05:31:56Z',
ipAccessList: [{description: '<string>', source: '<string>'}],
name: '<string>',
roles: []
})
};
fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}', 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}/keys/{keyId}",
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([
'expireAt' => '2023-11-07T05:31:56Z',
'ipAccessList' => [
[
'description' => '<string>',
'source' => '<string>'
]
],
'name' => '<string>',
'roles' => [
]
]),
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}/keys/{keyId}"
payload := strings.NewReader("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\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}/keys/{keyId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}")
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 \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}"
response = http.request(request)
puts response.read_body{
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"createdAt": "2023-11-07T05:31:56Z",
"expireAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"keySuffix": "<string>",
"name": "<string>",
"roles": [],
"usedAt": "2023-11-07T05:31:56Z"
},
"status": 200
}{
"error": "<string>",
"status": 400
}