Set audit log delivery
curl --request PUT \
--url https://{workspace}.klef.ai/api/audit/delivery \
--header 'Content-Type: application/json' \
--cookie klef.session= \
--data '
{
"serviceUrl": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
}
'import requests
url = "https://{workspace}.klef.ai/api/audit/delivery"
payload = {
"serviceUrl": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
}
headers = {
"cookie": "klef.session=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'klef.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
serviceUrl: '<string>',
region: '<string>',
bucket: '<string>',
prefix: '<string>',
accessKeyId: '<string>',
secretAccessKey: '<string>'
})
};
fetch('https://{workspace}.klef.ai/api/audit/delivery', 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://{workspace}.klef.ai/api/audit/delivery",
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([
'serviceUrl' => '<string>',
'region' => '<string>',
'bucket' => '<string>',
'prefix' => '<string>',
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>'
]),
CURLOPT_COOKIE => "klef.session=",
CURLOPT_HTTPHEADER => [
"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://{workspace}.klef.ai/api/audit/delivery"
payload := strings.NewReader("{\n \"serviceUrl\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "klef.session=")
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://{workspace}.klef.ai/api/audit/delivery")
.header("cookie", "klef.session=")
.header("Content-Type", "application/json")
.body("{\n \"serviceUrl\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/audit/delivery")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'klef.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"serviceUrl\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"serviceUrl": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"accessKeyId": "<string>",
"deliveredSequence": 123,
"deliveredAt": "2023-11-07T05:31:56Z",
"backlog": 123,
"failingSince": "2023-11-07T05:31:56Z",
"failure": {
"code": "details_unavailable",
"params": {},
"causes": "<array>"
},
"heldByKlef": true,
"warnings": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
]
},
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}Audit
Set audit log delivery
Audit event delivery to S3-compatible object storage.
PUT
/
audit
/
delivery
Set audit log delivery
curl --request PUT \
--url https://{workspace}.klef.ai/api/audit/delivery \
--header 'Content-Type: application/json' \
--cookie klef.session= \
--data '
{
"serviceUrl": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
}
'import requests
url = "https://{workspace}.klef.ai/api/audit/delivery"
payload = {
"serviceUrl": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>"
}
headers = {
"cookie": "klef.session=",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {cookie: 'klef.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
serviceUrl: '<string>',
region: '<string>',
bucket: '<string>',
prefix: '<string>',
accessKeyId: '<string>',
secretAccessKey: '<string>'
})
};
fetch('https://{workspace}.klef.ai/api/audit/delivery', 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://{workspace}.klef.ai/api/audit/delivery",
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([
'serviceUrl' => '<string>',
'region' => '<string>',
'bucket' => '<string>',
'prefix' => '<string>',
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>'
]),
CURLOPT_COOKIE => "klef.session=",
CURLOPT_HTTPHEADER => [
"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://{workspace}.klef.ai/api/audit/delivery"
payload := strings.NewReader("{\n \"serviceUrl\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "klef.session=")
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://{workspace}.klef.ai/api/audit/delivery")
.header("cookie", "klef.session=")
.header("Content-Type", "application/json")
.body("{\n \"serviceUrl\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/audit/delivery")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'klef.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"serviceUrl\": \"<string>\",\n \"region\": \"<string>\",\n \"bucket\": \"<string>\",\n \"prefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"serviceUrl": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"accessKeyId": "<string>",
"deliveredSequence": 123,
"deliveredAt": "2023-11-07T05:31:56Z",
"backlog": 123,
"failingSince": "2023-11-07T05:31:56Z",
"failure": {
"code": "details_unavailable",
"params": {},
"causes": "<array>"
},
"heldByKlef": true,
"warnings": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
]
},
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"code": "details_unavailable",
"params": {},
"causes": [
{
"code": "details_unavailable",
"params": {},
"causes": "<array>"
}
],
"target": "<string>"
}
]
}Authorizations
cookieAuthapiKeyAuth
Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.
Body
application/json
The S3 endpoint, or null for AWS S3 in Region.
Maximum string length:
2048Maximum string length:
64Minimum string length:
1Maximum string length:
512Maximum string length:
256Maximum string length:
512Was this page helpful?