Set rules
curl --request PUT \
--url https://{region}.api.plerion.com/v1/tenant/ownership/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"version": "9mQx2bTq4kLr7sVw1yZa0c",
"rules": [
{
"type": "tag",
"enabled": true,
"config": {
"key": "Team",
"from": "asset",
"newOwnersAre": "team"
}
},
{
"type": "tag",
"enabled": true,
"config": {
"key": "Owner",
"from": "asset",
"newOwnersAre": "person"
}
}
],
"owners": [
{
"value": "sre-oncall@example.com",
"kind": "team",
"key": "Owner"
}
]
}
'import requests
url = "https://{region}.api.plerion.com/v1/tenant/ownership/rules"
payload = {
"version": "9mQx2bTq4kLr7sVw1yZa0c",
"rules": [
{
"type": "tag",
"enabled": True,
"config": {
"key": "Team",
"from": "asset",
"newOwnersAre": "team"
}
},
{
"type": "tag",
"enabled": True,
"config": {
"key": "Owner",
"from": "asset",
"newOwnersAre": "person"
}
}
],
"owners": [
{
"value": "sre-oncall@example.com",
"kind": "team",
"key": "Owner"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version: '9mQx2bTq4kLr7sVw1yZa0c',
rules: [
{
type: 'tag',
enabled: true,
config: {key: 'Team', from: 'asset', newOwnersAre: 'team'}
},
{
type: 'tag',
enabled: true,
config: {key: 'Owner', from: 'asset', newOwnersAre: 'person'}
}
],
owners: [{value: 'sre-oncall@example.com', kind: 'team', key: 'Owner'}]
})
};
fetch('https://{region}.api.plerion.com/v1/tenant/ownership/rules', 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://{region}.api.plerion.com/v1/tenant/ownership/rules",
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([
'version' => '9mQx2bTq4kLr7sVw1yZa0c',
'rules' => [
[
'type' => 'tag',
'enabled' => true,
'config' => [
'key' => 'Team',
'from' => 'asset',
'newOwnersAre' => 'team'
]
],
[
'type' => 'tag',
'enabled' => true,
'config' => [
'key' => 'Owner',
'from' => 'asset',
'newOwnersAre' => 'person'
]
]
],
'owners' => [
[
'value' => 'sre-oncall@example.com',
'kind' => 'team',
'key' => 'Owner'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{region}.api.plerion.com/v1/tenant/ownership/rules"
payload := strings.NewReader("{\n \"version\": \"9mQx2bTq4kLr7sVw1yZa0c\",\n \"rules\": [\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Team\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"team\"\n }\n },\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Owner\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"person\"\n }\n }\n ],\n \"owners\": [\n {\n \"value\": \"sre-oncall@example.com\",\n \"kind\": \"team\",\n \"key\": \"Owner\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{region}.api.plerion.com/v1/tenant/ownership/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"version\": \"9mQx2bTq4kLr7sVw1yZa0c\",\n \"rules\": [\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Team\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"team\"\n }\n },\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Owner\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"person\"\n }\n }\n ],\n \"owners\": [\n {\n \"value\": \"sre-oncall@example.com\",\n \"kind\": \"team\",\n \"key\": \"Owner\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{region}.api.plerion.com/v1/tenant/ownership/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"version\": \"9mQx2bTq4kLr7sVw1yZa0c\",\n \"rules\": [\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Team\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"team\"\n }\n },\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Owner\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"person\"\n }\n }\n ],\n \"owners\": [\n {\n \"value\": \"sre-oncall@example.com\",\n \"kind\": \"team\",\n \"key\": \"Owner\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"rules": [
{
"type": "tag",
"config": {
"key": "Team",
"from": "asset",
"newOwnersAre": "team",
"always": true,
"ignoreValues": [
"<string>"
],
"keepValues": [
"<string>"
]
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"priority": 1,
"origin": "detected",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"version": "9mQx2bTq4kLr7sVw1yZa0c"
}
}{
"errors": [
{
"code": "NameTaken",
"message": "Payments already goes by \"payments\". Use that one instead."
}
]
}{
"message": "Forbidden"
}{
"errors": [
{
"code": "NameTaken",
"message": "Payments already goes by \"payments\". Use that one instead."
}
]
}{
"message": "Internal server error"
}Set ownership rules
Replaces the tenant’s ownership rules with this list, in this order, then works out every asset’s owners again in the background. The response does not wait for that: follow its progress in scan on Get ownership summary.
Every value a rule’s tag holds becomes an owner, a team or a person. Plerion decides the kind per value (emails are people, group names and tools are teams) unless the rule sets always. Send owners to settle the kind of particular values, as the setup in the Plerion app does.
The list replaces every rule, so start from List ownership rules and send its rules back with your change. Send its version too (in the body or as an If-Match header): if the rules changed since you read them, the request is refused (409 RulesChanged) and nothing is saved. Without version the list is saved as sent.
A tag with more than 2,000 different values is refused (TooManyValues): that many values are IDs, not owners. One owner tag per key and side (DuplicateRule). An additional rule must name a team or person that exists (OwnerNotFound). Requires OwnershipRule:Modify.
PUT
/
v1
/
tenant
/
ownership
/
rules
Set rules
curl --request PUT \
--url https://{region}.api.plerion.com/v1/tenant/ownership/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"version": "9mQx2bTq4kLr7sVw1yZa0c",
"rules": [
{
"type": "tag",
"enabled": true,
"config": {
"key": "Team",
"from": "asset",
"newOwnersAre": "team"
}
},
{
"type": "tag",
"enabled": true,
"config": {
"key": "Owner",
"from": "asset",
"newOwnersAre": "person"
}
}
],
"owners": [
{
"value": "sre-oncall@example.com",
"kind": "team",
"key": "Owner"
}
]
}
'import requests
url = "https://{region}.api.plerion.com/v1/tenant/ownership/rules"
payload = {
"version": "9mQx2bTq4kLr7sVw1yZa0c",
"rules": [
{
"type": "tag",
"enabled": True,
"config": {
"key": "Team",
"from": "asset",
"newOwnersAre": "team"
}
},
{
"type": "tag",
"enabled": True,
"config": {
"key": "Owner",
"from": "asset",
"newOwnersAre": "person"
}
}
],
"owners": [
{
"value": "sre-oncall@example.com",
"kind": "team",
"key": "Owner"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version: '9mQx2bTq4kLr7sVw1yZa0c',
rules: [
{
type: 'tag',
enabled: true,
config: {key: 'Team', from: 'asset', newOwnersAre: 'team'}
},
{
type: 'tag',
enabled: true,
config: {key: 'Owner', from: 'asset', newOwnersAre: 'person'}
}
],
owners: [{value: 'sre-oncall@example.com', kind: 'team', key: 'Owner'}]
})
};
fetch('https://{region}.api.plerion.com/v1/tenant/ownership/rules', 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://{region}.api.plerion.com/v1/tenant/ownership/rules",
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([
'version' => '9mQx2bTq4kLr7sVw1yZa0c',
'rules' => [
[
'type' => 'tag',
'enabled' => true,
'config' => [
'key' => 'Team',
'from' => 'asset',
'newOwnersAre' => 'team'
]
],
[
'type' => 'tag',
'enabled' => true,
'config' => [
'key' => 'Owner',
'from' => 'asset',
'newOwnersAre' => 'person'
]
]
],
'owners' => [
[
'value' => 'sre-oncall@example.com',
'kind' => 'team',
'key' => 'Owner'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{region}.api.plerion.com/v1/tenant/ownership/rules"
payload := strings.NewReader("{\n \"version\": \"9mQx2bTq4kLr7sVw1yZa0c\",\n \"rules\": [\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Team\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"team\"\n }\n },\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Owner\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"person\"\n }\n }\n ],\n \"owners\": [\n {\n \"value\": \"sre-oncall@example.com\",\n \"kind\": \"team\",\n \"key\": \"Owner\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{region}.api.plerion.com/v1/tenant/ownership/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"version\": \"9mQx2bTq4kLr7sVw1yZa0c\",\n \"rules\": [\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Team\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"team\"\n }\n },\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Owner\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"person\"\n }\n }\n ],\n \"owners\": [\n {\n \"value\": \"sre-oncall@example.com\",\n \"kind\": \"team\",\n \"key\": \"Owner\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{region}.api.plerion.com/v1/tenant/ownership/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"version\": \"9mQx2bTq4kLr7sVw1yZa0c\",\n \"rules\": [\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Team\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"team\"\n }\n },\n {\n \"type\": \"tag\",\n \"enabled\": true,\n \"config\": {\n \"key\": \"Owner\",\n \"from\": \"asset\",\n \"newOwnersAre\": \"person\"\n }\n }\n ],\n \"owners\": [\n {\n \"value\": \"sre-oncall@example.com\",\n \"kind\": \"team\",\n \"key\": \"Owner\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"rules": [
{
"type": "tag",
"config": {
"key": "Team",
"from": "asset",
"newOwnersAre": "team",
"always": true,
"ignoreValues": [
"<string>"
],
"keepValues": [
"<string>"
]
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"priority": 1,
"origin": "detected",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"version": "9mQx2bTq4kLr7sVw1yZa0c"
}
}{
"errors": [
{
"code": "NameTaken",
"message": "Payments already goes by \"payments\". Use that one instead."
}
]
}{
"message": "Forbidden"
}{
"errors": [
{
"code": "NameTaken",
"message": "Payments already goes by \"payments\". Use that one instead."
}
]
}{
"message": "Internal server error"
}Authorizations
Bearer API Key. For example, "Bearer {Tenant API Key}"
Headers
Bearer API Key. For example, "Bearer {Tenant API Key}"
application/json
Body
application/json
The rules in priority order, first wins. Rules read only from integration tags are moved after the rest, so an asset's own tags are always tried first. Whatever the order, an assign rule with overrideTags is tried before the owner tags, and one without it after them. At most 20 owner tags and 200 additional rules. Keep a rule's id to keep the owners it found linked to it.
Maximum array length:
220Show child attributes
Show child attributes
The version of the whole rule list. It changes whenever any rule is added, removed, moved or edited. Send it back with a change so a change made meanwhile is not overwritten.
Example:
"9mQx2bTq4kLr7sVw1yZa0c"
Optional. The kind of particular values, overriding Plerion's guess.
Maximum array length:
500Show child attributes
Show child attributes
Response
The rules as saved
Show child attributes
Show child attributes
Was this page helpful?