API Keys
Enable or Disable API Key
Temporarily disable an API key or re-enable a disabled one.
PATCH
/
api
/
agent
/
keys
Enable or Disable API Key
curl --request PATCH \
--url https://encrata.com/api/agent/keys \
--header 'Authorization: Bearer <token>'import requests
url = "https://encrata.com/api/agent/keys"
headers = {"Authorization": "Bearer <token>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
fetch('https://encrata.com/api/agent/keys', 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://encrata.com/api/agent/keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://encrata.com/api/agent/keys"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://encrata.com/api/agent/keys")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://encrata.com/api/agent/keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "API key disabled"
}
{
"error": "Key ID and action (disable|enable) are required"
}
{
"error": "Unauthorized"
}
{
"error": "Insufficient permissions"
}
{
"error": "API key not found"
}
Authentication
Requires an API key in theAuthorization header.
Authorization: Bearer YOUR_API_KEY
Request
string
required
The ID of the API key to enable or disable.
string
required
The action to perform. One of
disable or enable.Disable a key
curl -X PATCH "https://encrata.com/api/agent/keys?id=key_abc123&action=disable" \
-H "Authorization: Bearer YOUR_API_KEY"
Re-enable a key
curl -X PATCH "https://encrata.com/api/agent/keys?id=key_abc123&action=enable" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
{
"message": "API key disabled"
}
Disabling is reversible re-enable the same key with
action=enable. A disabled
key immediately returns 401 on any request. Requires a non-readonly role in the
active workspace.{
"message": "API key disabled"
}
{
"error": "Key ID and action (disable|enable) are required"
}
{
"error": "Unauthorized"
}
{
"error": "Insufficient permissions"
}
{
"error": "API key not found"
}
Was this page helpful?
⌘I
Enable or Disable API Key
curl --request PATCH \
--url https://encrata.com/api/agent/keys \
--header 'Authorization: Bearer <token>'import requests
url = "https://encrata.com/api/agent/keys"
headers = {"Authorization": "Bearer <token>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
fetch('https://encrata.com/api/agent/keys', 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://encrata.com/api/agent/keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://encrata.com/api/agent/keys"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://encrata.com/api/agent/keys")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://encrata.com/api/agent/keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "API key disabled"
}
{
"error": "Key ID and action (disable|enable) are required"
}
{
"error": "Unauthorized"
}
{
"error": "Insufficient permissions"
}
{
"error": "API key not found"
}