Update Api Key
curl --request PATCH \
--url http://localhost:8000/auth/api-keys/{key_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production Integration Key",
"scopes": [
"documents:read",
"documents:write"
]
}
'import requests
url = "http://localhost:8000/auth/api-keys/{key_id}"
payload = {
"name": "Production Integration Key",
"scopes": ["documents:read", "documents:write"]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Production Integration Key',
scopes: ['documents:read', 'documents:write']
})
};
fetch('http://localhost:8000/auth/api-keys/{key_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/auth/api-keys/{key_id}",
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([
'name' => 'Production Integration Key',
'scopes' => [
'documents:read',
'documents:write'
]
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:8000/auth/api-keys/{key_id}"
payload := strings.NewReader("{\n \"name\": \"Production Integration Key\",\n \"scopes\": [\n \"documents:read\",\n \"documents:write\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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("http://localhost:8000/auth/api-keys/{key_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Integration Key\",\n \"scopes\": [\n \"documents:read\",\n \"documents:write\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/auth/api-keys/{key_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production Integration Key\",\n \"scopes\": [\n \"documents:read\",\n \"documents:write\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2024-01-01T00:00:00Z",
"id": "cc0e8400-e29b-41d4-a716-446655440000",
"is_active": true,
"key_prefix": "fac_abc",
"last_used_at": "2024-06-01T12:00:00Z",
"name": "Production Integration Key",
"scopes": [
"documents:read",
"documents:write"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authentication
Update Api Key
Update an API key’s name or scopes.
This endpoint allows partial updates - only the fields provided in the request will be modified. The key_hash is never exposed in the response.
Args: key_id: API key ID to update request: Partial update payload with optional name and/or scopes db: Async database session tenant_id: Active tenant ID current_user: Authenticated user (must be tenant_admin or tenant_owner)
Returns: APIKeyResponse: Updated API key metadata (without key_hash)
Raises: HTTPException 404: If API key not found or doesn’t belong to tenant HTTPException 403: If user doesn’t have permission
PATCH
/
auth
/
api-keys
/
{key_id}
Update Api Key
curl --request PATCH \
--url http://localhost:8000/auth/api-keys/{key_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production Integration Key",
"scopes": [
"documents:read",
"documents:write"
]
}
'import requests
url = "http://localhost:8000/auth/api-keys/{key_id}"
payload = {
"name": "Production Integration Key",
"scopes": ["documents:read", "documents:write"]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Production Integration Key',
scopes: ['documents:read', 'documents:write']
})
};
fetch('http://localhost:8000/auth/api-keys/{key_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/auth/api-keys/{key_id}",
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([
'name' => 'Production Integration Key',
'scopes' => [
'documents:read',
'documents:write'
]
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:8000/auth/api-keys/{key_id}"
payload := strings.NewReader("{\n \"name\": \"Production Integration Key\",\n \"scopes\": [\n \"documents:read\",\n \"documents:write\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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("http://localhost:8000/auth/api-keys/{key_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Integration Key\",\n \"scopes\": [\n \"documents:read\",\n \"documents:write\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/auth/api-keys/{key_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production Integration Key\",\n \"scopes\": [\n \"documents:read\",\n \"documents:write\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2024-01-01T00:00:00Z",
"id": "cc0e8400-e29b-41d4-a716-446655440000",
"is_active": true,
"key_prefix": "fac_abc",
"last_used_at": "2024-06-01T12:00:00Z",
"name": "Production Integration Key",
"scopes": [
"documents:read",
"documents:write"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Cookies
Body
application/json