Create API Key
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3 \
--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\":[]}",
"hashed": true,
"keyPermissions": {
"permissions": [
"read_logs"
],
"presets": [
"my_preset"
]
},
"name": "my_api_key",
"owner": {
"userId": "<string>",
"organisationId": "<string>",
"teamId": 1
}
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3"
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\":[]}",
"hashed": True,
"keyPermissions": {
"permissions": ["read_logs"],
"presets": ["my_preset"]
},
"name": "my_api_key",
"owner": {
"userId": "<string>",
"organisationId": "<string>",
"teamId": 1
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
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":[]}',
hashed: true,
keyPermissions: {permissions: ['read_logs'], presets: ['my_preset']},
name: 'my_api_key',
owner: {userId: '<string>', organisationId: '<string>', teamId: 1}
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3', 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/5/aaa/api-keys/v3",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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":[]}',
'hashed' => true,
'keyPermissions' => [
'permissions' => [
'read_logs'
],
'presets' => [
'my_preset'
]
],
'name' => 'my_api_key',
'owner' => [
'userId' => '<string>',
'organisationId' => '<string>',
'teamId' => 1
]
]),
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/5/aaa/api-keys/v3"
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 \"hashed\": true,\n \"keyPermissions\": {\n \"permissions\": [\n \"read_logs\"\n ],\n \"presets\": [\n \"my_preset\"\n ]\n },\n \"name\": \"my_api_key\",\n \"owner\": {\n \"userId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"teamId\": 1\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3")
.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 \"hashed\": true,\n \"keyPermissions\": {\n \"permissions\": [\n \"read_logs\"\n ],\n \"presets\": [\n \"my_preset\"\n ]\n },\n \"name\": \"my_api_key\",\n \"owner\": {\n \"userId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"teamId\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"hashed\": true,\n \"keyPermissions\": {\n \"permissions\": [\n \"read_logs\"\n ],\n \"presets\": [\n \"my_preset\"\n ]\n },\n \"name\": \"my_api_key\",\n \"owner\": {\n \"userId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"teamId\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"keyId": "my_key_id",
"name": "my_api_key",
"value": "my_api_key_value"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}API Keys Service
Create API Key
Creates a new API key for the authenticated team.
Create API Key
curl --request POST \
--url https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3 \
--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\":[]}",
"hashed": true,
"keyPermissions": {
"permissions": [
"read_logs"
],
"presets": [
"my_preset"
]
},
"name": "my_api_key",
"owner": {
"userId": "<string>",
"organisationId": "<string>",
"teamId": 1
}
}
'import requests
url = "https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3"
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\":[]}",
"hashed": True,
"keyPermissions": {
"permissions": ["read_logs"],
"presets": ["my_preset"]
},
"name": "my_api_key",
"owner": {
"userId": "<string>",
"organisationId": "<string>",
"teamId": 1
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
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":[]}',
hashed: true,
keyPermissions: {permissions: ['read_logs'], presets: ['my_preset']},
name: 'my_api_key',
owner: {userId: '<string>', organisationId: '<string>', teamId: 1}
})
};
fetch('https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3', 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/5/aaa/api-keys/v3",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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":[]}',
'hashed' => true,
'keyPermissions' => [
'permissions' => [
'read_logs'
],
'presets' => [
'my_preset'
]
],
'name' => 'my_api_key',
'owner' => [
'userId' => '<string>',
'organisationId' => '<string>',
'teamId' => 1
]
]),
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/5/aaa/api-keys/v3"
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 \"hashed\": true,\n \"keyPermissions\": {\n \"permissions\": [\n \"read_logs\"\n ],\n \"presets\": [\n \"my_preset\"\n ]\n },\n \"name\": \"my_api_key\",\n \"owner\": {\n \"userId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"teamId\": 1\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3")
.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 \"hashed\": true,\n \"keyPermissions\": {\n \"permissions\": [\n \"read_logs\"\n ],\n \"presets\": [\n \"my_preset\"\n ]\n },\n \"name\": \"my_api_key\",\n \"owner\": {\n \"userId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"teamId\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.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 \"hashed\": true,\n \"keyPermissions\": {\n \"permissions\": [\n \"read_logs\"\n ],\n \"presets\": [\n \"my_preset\"\n ]\n },\n \"name\": \"my_api_key\",\n \"owner\": {\n \"userId\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"teamId\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"keyId": "my_key_id",
"name": "my_api_key",
"value": "my_api_key_value"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}{
"code": 349,
"message": "<string>"
}Authorizations
API key authentication
Body
application/json
This data structure is used to create an API key.
JSON string representing the access policy for this API key. Defines granular permissions for users and groups.
Example:
"{\"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\":[]}"
Whether the value is stored as a one-way hash.
Example:
true
This data structure allows to specify loose permissions and permission presets for an API key.
Show child attributes
Show child attributes
Display name.
Example:
"my_api_key"
Owner.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Was this page helpful?
⌘I