curl --request PUT \
--url https://api.example.com/api/auth/api-keys/{user_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"condition": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"description": "<string>",
"policy_data": {},
"scopes": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/auth/api-keys/{user_id}"
payload = {
"condition": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"description": "<string>",
"policy_data": {},
"scopes": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
condition: {content: '<string>', id: '<string>', kwargs: {}},
description: '<string>',
policy_data: {},
scopes: ['<string>']
})
};
fetch('https://api.example.com/api/auth/api-keys/{user_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_URL => "https://api.example.com/api/auth/api-keys/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'condition' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'description' => '<string>',
'policy_data' => [
],
'scopes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.example.com/api/auth/api-keys/{user_id}"
payload := strings.NewReader("{\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"description\": \"<string>\",\n \"policy_data\": {},\n \"scopes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.example.com/api/auth/api-keys/{user_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"description\": \"<string>\",\n \"policy_data\": {},\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/api-keys/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"description\": \"<string>\",\n \"policy_data\": {},\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true,
"user_id": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Edit an api key
A PATCH-style partial edit: only the fields present in updates are
overwritten; a field absent is preserved at its stored value, so saving a
description or scope change never silently drops an authorization condition or
policy_data gate. updates is the sparse set of present fields (a single dict
rather than flattened params, so “field absent” stays distinct from “field is
null” — the partial-edit semantics a flat signature cannot express).
curl --request PUT \
--url https://api.example.com/api/auth/api-keys/{user_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"condition": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"description": "<string>",
"policy_data": {},
"scopes": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/auth/api-keys/{user_id}"
payload = {
"condition": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"description": "<string>",
"policy_data": {},
"scopes": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
condition: {content: '<string>', id: '<string>', kwargs: {}},
description: '<string>',
policy_data: {},
scopes: ['<string>']
})
};
fetch('https://api.example.com/api/auth/api-keys/{user_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_URL => "https://api.example.com/api/auth/api-keys/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'condition' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'description' => '<string>',
'policy_data' => [
],
'scopes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.example.com/api/auth/api-keys/{user_id}"
payload := strings.NewReader("{\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"description\": \"<string>\",\n \"policy_data\": {},\n \"scopes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.example.com/api/auth/api-keys/{user_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"description\": \"<string>\",\n \"policy_data\": {},\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/auth/api-keys/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"description\": \"<string>\",\n \"policy_data\": {},\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true,
"user_id": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Body
A partial api-key edit — only the fields present are overwritten; a
null/{}/"" value clears an optional gate.
A renderable text: its source plus the parameters its render takes.
EXACTLY ONE source is set — content (the text inline) or id (the id of a
stored resource holding the text); neither and both are refused at construction.
kwargs are the render parameters for the TEXT and apply either way, so moving a
text from inline to stored (or back) leaves its parameters untouched.
Show child attributes
Show child attributes
1Response
Success.
Acknowledges an api-key edit.
Show child attributes
Show child attributes

