curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"data-ingest-api-keys:ReadAccessPolicy\":\"grant\",\"data-ingest-api-keys:Manage\":\"deny\",\"data-ingest-api-keys:UpdateAccessPolicy\":\"deny\",\"data-ingest-api-keys:ReadConfig\":\"grant\"}},\"rules\":[]}",
"isActive": true,
"newName": "my_new_name",
"permissions": {
"permissions": [
"<string>"
]
},
"presets": {
"presets": [
"<string>"
]
}
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}"
payload = {
"accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"data-ingest-api-keys:ReadAccessPolicy\":\"grant\",\"data-ingest-api-keys:Manage\":\"deny\",\"data-ingest-api-keys:UpdateAccessPolicy\":\"deny\",\"data-ingest-api-keys:ReadConfig\":\"grant\"}},\"rules\":[]}",
"isActive": True,
"newName": "my_new_name",
"permissions": { "permissions": ["<string>"] },
"presets": { "presets": ["<string>"] }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accessPolicy: '{"version":"2025-01-01","default":{"permissions":{"data-ingest-api-keys:ReadAccessPolicy":"grant","data-ingest-api-keys:Manage":"deny","data-ingest-api-keys:UpdateAccessPolicy":"deny","data-ingest-api-keys:ReadConfig":"grant"}},"rules":[]}',
isActive: true,
newName: 'my_new_name',
permissions: {permissions: ['<string>']},
presets: {presets: ['<string>']}
})
};
fetch('https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{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_URL => "https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_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([
'accessPolicy' => '{"version":"2025-01-01","default":{"permissions":{"data-ingest-api-keys:ReadAccessPolicy":"grant","data-ingest-api-keys:Manage":"deny","data-ingest-api-keys:UpdateAccessPolicy":"deny","data-ingest-api-keys:ReadConfig":"grant"}},"rules":[]}',
'isActive' => true,
'newName' => 'my_new_name',
'permissions' => [
'permissions' => [
'<string>'
]
],
'presets' => [
'presets' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}"
payload := strings.NewReader("{\n \"accessPolicy\": \"{\\\"version\\\":\\\"2025-01-01\\\",\\\"default\\\":{\\\"permissions\\\":{\\\"data-ingest-api-keys:ReadAccessPolicy\\\":\\\"grant\\\",\\\"data-ingest-api-keys:Manage\\\":\\\"deny\\\",\\\"data-ingest-api-keys:UpdateAccessPolicy\\\":\\\"deny\\\",\\\"data-ingest-api-keys:ReadConfig\\\":\\\"grant\\\"}},\\\"rules\\\":[]}\",\n \"isActive\": true,\n \"newName\": \"my_new_name\",\n \"permissions\": {\n \"permissions\": [\n \"<string>\"\n ]\n },\n \"presets\": {\n \"presets\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessPolicy\": \"{\\\"version\\\":\\\"2025-01-01\\\",\\\"default\\\":{\\\"permissions\\\":{\\\"data-ingest-api-keys:ReadAccessPolicy\\\":\\\"grant\\\",\\\"data-ingest-api-keys:Manage\\\":\\\"deny\\\",\\\"data-ingest-api-keys:UpdateAccessPolicy\\\":\\\"deny\\\",\\\"data-ingest-api-keys:ReadConfig\\\":\\\"grant\\\"}},\\\"rules\\\":[]}\",\n \"isActive\": true,\n \"newName\": \"my_new_name\",\n \"permissions\": {\n \"permissions\": [\n \"<string>\"\n ]\n },\n \"presets\": {\n \"presets\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accessPolicy\": \"{\\\"version\\\":\\\"2025-01-01\\\",\\\"default\\\":{\\\"permissions\\\":{\\\"data-ingest-api-keys:ReadAccessPolicy\\\":\\\"grant\\\",\\\"data-ingest-api-keys:Manage\\\":\\\"deny\\\",\\\"data-ingest-api-keys:UpdateAccessPolicy\\\":\\\"deny\\\",\\\"data-ingest-api-keys:ReadConfig\\\":\\\"grant\\\"}},\\\"rules\\\":[]}\",\n \"isActive\": true,\n \"newName\": \"my_new_name\",\n \"permissions\": {\n \"permissions\": [\n \"<string>\"\n ]\n },\n \"presets\": {\n \"presets\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{}Update API Key
No description available
curl --request PUT \
--url https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"data-ingest-api-keys:ReadAccessPolicy\":\"grant\",\"data-ingest-api-keys:Manage\":\"deny\",\"data-ingest-api-keys:UpdateAccessPolicy\":\"deny\",\"data-ingest-api-keys:ReadConfig\":\"grant\"}},\"rules\":[]}",
"isActive": true,
"newName": "my_new_name",
"permissions": {
"permissions": [
"<string>"
]
},
"presets": {
"presets": [
"<string>"
]
}
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}"
payload = {
"accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"data-ingest-api-keys:ReadAccessPolicy\":\"grant\",\"data-ingest-api-keys:Manage\":\"deny\",\"data-ingest-api-keys:UpdateAccessPolicy\":\"deny\",\"data-ingest-api-keys:ReadConfig\":\"grant\"}},\"rules\":[]}",
"isActive": True,
"newName": "my_new_name",
"permissions": { "permissions": ["<string>"] },
"presets": { "presets": ["<string>"] }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accessPolicy: '{"version":"2025-01-01","default":{"permissions":{"data-ingest-api-keys:ReadAccessPolicy":"grant","data-ingest-api-keys:Manage":"deny","data-ingest-api-keys:UpdateAccessPolicy":"deny","data-ingest-api-keys:ReadConfig":"grant"}},"rules":[]}',
isActive: true,
newName: 'my_new_name',
permissions: {permissions: ['<string>']},
presets: {presets: ['<string>']}
})
};
fetch('https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{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_URL => "https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_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([
'accessPolicy' => '{"version":"2025-01-01","default":{"permissions":{"data-ingest-api-keys:ReadAccessPolicy":"grant","data-ingest-api-keys:Manage":"deny","data-ingest-api-keys:UpdateAccessPolicy":"deny","data-ingest-api-keys:ReadConfig":"grant"}},"rules":[]}',
'isActive' => true,
'newName' => 'my_new_name',
'permissions' => [
'permissions' => [
'<string>'
]
],
'presets' => [
'presets' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}"
payload := strings.NewReader("{\n \"accessPolicy\": \"{\\\"version\\\":\\\"2025-01-01\\\",\\\"default\\\":{\\\"permissions\\\":{\\\"data-ingest-api-keys:ReadAccessPolicy\\\":\\\"grant\\\",\\\"data-ingest-api-keys:Manage\\\":\\\"deny\\\",\\\"data-ingest-api-keys:UpdateAccessPolicy\\\":\\\"deny\\\",\\\"data-ingest-api-keys:ReadConfig\\\":\\\"grant\\\"}},\\\"rules\\\":[]}\",\n \"isActive\": true,\n \"newName\": \"my_new_name\",\n \"permissions\": {\n \"permissions\": [\n \"<string>\"\n ]\n },\n \"presets\": {\n \"presets\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessPolicy\": \"{\\\"version\\\":\\\"2025-01-01\\\",\\\"default\\\":{\\\"permissions\\\":{\\\"data-ingest-api-keys:ReadAccessPolicy\\\":\\\"grant\\\",\\\"data-ingest-api-keys:Manage\\\":\\\"deny\\\",\\\"data-ingest-api-keys:UpdateAccessPolicy\\\":\\\"deny\\\",\\\"data-ingest-api-keys:ReadConfig\\\":\\\"grant\\\"}},\\\"rules\\\":[]}\",\n \"isActive\": true,\n \"newName\": \"my_new_name\",\n \"permissions\": {\n \"permissions\": [\n \"<string>\"\n ]\n },\n \"presets\": {\n \"presets\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/3/aaa/api-keys/v3/{key_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accessPolicy\": \"{\\\"version\\\":\\\"2025-01-01\\\",\\\"default\\\":{\\\"permissions\\\":{\\\"data-ingest-api-keys:ReadAccessPolicy\\\":\\\"grant\\\",\\\"data-ingest-api-keys:Manage\\\":\\\"deny\\\",\\\"data-ingest-api-keys:UpdateAccessPolicy\\\":\\\"deny\\\",\\\"data-ingest-api-keys:ReadConfig\\\":\\\"grant\\\"}},\\\"rules\\\":[]}\",\n \"isActive\": true,\n \"newName\": \"my_new_name\",\n \"permissions\": {\n \"permissions\": [\n \"<string>\"\n ]\n },\n \"presets\": {\n \"presets\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{}Authorizations
API key authentication
Path Parameters
"my_key_id"
Body
This data structure is used to update an API key.
JSON string representing the access policy for this API key. Defines granular permissions for users and groups. To delete an existing policy, pass an empty string.
"{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"data-ingest-api-keys:ReadAccessPolicy\":\"grant\",\"data-ingest-api-keys:Manage\":\"deny\",\"data-ingest-api-keys:UpdateAccessPolicy\":\"deny\",\"data-ingest-api-keys:ReadConfig\":\"grant\"}},\"rules\":[]}"
true
"my_new_name"
This data structure represents a set of permissions on an API key.
Show child attributes
Show child attributes
This data structure represents a set of permissions presets on an API key.
Show child attributes
Show child attributes
Response
The response is of type object.
Was this page helpful?