Update an API key
curl --request PATCH \
--url https://api.example.com/keys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"type_permissions": {},
"extension_permissions": {},
"edge_permissions": {},
"metadata_permissions": {},
"source": null,
"role": null
}
'import requests
url = "https://api.example.com/keys/{id}"
payload = {
"label": "<string>",
"type_permissions": {},
"extension_permissions": {},
"edge_permissions": {},
"metadata_permissions": {},
"source": None,
"role": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
type_permissions: {},
extension_permissions: {},
edge_permissions: {},
metadata_permissions: {},
source: null,
role: null
})
};
fetch('https://api.example.com/keys/{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/keys/{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([
'label' => '<string>',
'type_permissions' => [
],
'extension_permissions' => [
],
'edge_permissions' => [
],
'metadata_permissions' => [
],
'source' => null,
'role' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.example.com/keys/{id}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"type_permissions\": {},\n \"extension_permissions\": {},\n \"edge_permissions\": {},\n \"metadata_permissions\": {},\n \"source\": null,\n \"role\": null\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/keys/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"type_permissions\": {},\n \"extension_permissions\": {},\n \"edge_permissions\": {},\n \"metadata_permissions\": {},\n \"source\": null,\n \"role\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"type_permissions\": {},\n \"extension_permissions\": {},\n \"edge_permissions\": {},\n \"metadata_permissions\": {},\n \"source\": null,\n \"role\": null\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"label": "<string>",
"source": "<string>",
"role": "admin",
"default_tier": "library",
"is_platform": true,
"type_permissions": {},
"created_at": "<string>",
"last_used_at": "<string>",
"extension_permissions": {},
"edge_permissions": {},
"metadata_permissions": {}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "api_key_not_found",
"message": "<string>",
"details": {}
}
}Keys
Update an API key
Updates mutable fields on an API key in place — label, default_tier, and the four permission maps (type_permissions, extension_permissions, edge_permissions, metadata_permissions). source and role are immutable after creation and rejected with 400 validation_error if present in the body — to change them, revoke and recreate. Admin or tenant_admin only.
PATCH
/
keys
/
{id}
Update an API key
curl --request PATCH \
--url https://api.example.com/keys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"type_permissions": {},
"extension_permissions": {},
"edge_permissions": {},
"metadata_permissions": {},
"source": null,
"role": null
}
'import requests
url = "https://api.example.com/keys/{id}"
payload = {
"label": "<string>",
"type_permissions": {},
"extension_permissions": {},
"edge_permissions": {},
"metadata_permissions": {},
"source": None,
"role": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
type_permissions: {},
extension_permissions: {},
edge_permissions: {},
metadata_permissions: {},
source: null,
role: null
})
};
fetch('https://api.example.com/keys/{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/keys/{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([
'label' => '<string>',
'type_permissions' => [
],
'extension_permissions' => [
],
'edge_permissions' => [
],
'metadata_permissions' => [
],
'source' => null,
'role' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.example.com/keys/{id}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"type_permissions\": {},\n \"extension_permissions\": {},\n \"edge_permissions\": {},\n \"metadata_permissions\": {},\n \"source\": null,\n \"role\": null\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/keys/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"type_permissions\": {},\n \"extension_permissions\": {},\n \"edge_permissions\": {},\n \"metadata_permissions\": {},\n \"source\": null,\n \"role\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"type_permissions\": {},\n \"extension_permissions\": {},\n \"edge_permissions\": {},\n \"metadata_permissions\": {},\n \"source\": null,\n \"role\": null\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"label": "<string>",
"source": "<string>",
"role": "admin",
"default_tier": "library",
"is_platform": true,
"type_permissions": {},
"created_at": "<string>",
"last_used_at": "<string>",
"extension_permissions": {},
"edge_permissions": {},
"metadata_permissions": {}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "api_key_not_found",
"message": "<string>",
"details": {}
}
}Authorizations
Pass an API key (marfa_k1_...) or OAuth access token (marfa_at_...)
Path Parameters
Body
application/json
Minimum string length:
1Available options:
library, feed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Key updated
Available options:
admin, tenant_admin, member Available options:
library, feed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes