Replace the agent policy (admin)
curl --request PUT \
--url http://localhost:8080/api/v1/policy \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"actions": {},
"overrides": {},
"limits": {
"pendingTtlHours": 24,
"maxPendingPerActor": 50
}
}
'import requests
url = "http://localhost:8080/api/v1/policy"
payload = {
"actions": {},
"overrides": {},
"limits": {
"pendingTtlHours": 24,
"maxPendingPerActor": 50
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actions: {},
overrides: {},
limits: {pendingTtlHours: 24, maxPendingPerActor: 50}
})
};
fetch('http://localhost:8080/api/v1/policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/policy",
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([
'actions' => [
],
'overrides' => [
],
'limits' => [
'pendingTtlHours' => 24,
'maxPendingPerActor' => 50
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:8080/api/v1/policy"
payload := strings.NewReader("{\n \"actions\": {},\n \"overrides\": {},\n \"limits\": {\n \"pendingTtlHours\": 24,\n \"maxPendingPerActor\": 50\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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("http://localhost:8080/api/v1/policy")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actions\": {},\n \"overrides\": {},\n \"limits\": {\n \"pendingTtlHours\": 24,\n \"maxPendingPerActor\": 50\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/policy")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actions\": {},\n \"overrides\": {},\n \"limits\": {\n \"pendingTtlHours\": 24,\n \"maxPendingPerActor\": 50\n }\n}"
response = http.request(request)
puts response.read_bodyAgent Policy
Replace the agent policy (admin)
Admin-only, and never permitted from an agent-initiated request regardless of key capabilities. Unknown action keys, bad modes or malformed overrides are rejected with 400 naming the problem.
PUT
/
api
/
v1
/
policy
Replace the agent policy (admin)
curl --request PUT \
--url http://localhost:8080/api/v1/policy \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"actions": {},
"overrides": {},
"limits": {
"pendingTtlHours": 24,
"maxPendingPerActor": 50
}
}
'import requests
url = "http://localhost:8080/api/v1/policy"
payload = {
"actions": {},
"overrides": {},
"limits": {
"pendingTtlHours": 24,
"maxPendingPerActor": 50
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actions: {},
overrides: {},
limits: {pendingTtlHours: 24, maxPendingPerActor: 50}
})
};
fetch('http://localhost:8080/api/v1/policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/policy",
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([
'actions' => [
],
'overrides' => [
],
'limits' => [
'pendingTtlHours' => 24,
'maxPendingPerActor' => 50
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:8080/api/v1/policy"
payload := strings.NewReader("{\n \"actions\": {},\n \"overrides\": {},\n \"limits\": {\n \"pendingTtlHours\": 24,\n \"maxPendingPerActor\": 50\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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("http://localhost:8080/api/v1/policy")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actions\": {},\n \"overrides\": {},\n \"limits\": {\n \"pendingTtlHours\": 24,\n \"maxPendingPerActor\": 50\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/policy")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actions\": {},\n \"overrides\": {},\n \"limits\": {\n \"pendingTtlHours\": 24,\n \"maxPendingPerActor\": 50\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Optional API key for authentication (enabled via application.yaml)
Body
application/json
Response
The saved policy (version incremented)
