createList
curl --request POST \
--url https://api.artemis.cynopsis.co/api/own-restricted-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"listName": "<string>",
"active": true,
"domainIds": [
123
]
}
'import requests
url = "https://api.artemis.cynopsis.co/api/own-restricted-list"
payload = {
"listName": "<string>",
"active": True,
"domainIds": [123]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({listName: '<string>', active: true, domainIds: [123]})
};
fetch('https://api.artemis.cynopsis.co/api/own-restricted-list', 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.artemis.cynopsis.co/api/own-restricted-list",
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([
'listName' => '<string>',
'active' => true,
'domainIds' => [
123
]
]),
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://api.artemis.cynopsis.co/api/own-restricted-list"
payload := strings.NewReader("{\n \"listName\": \"<string>\",\n \"active\": true,\n \"domainIds\": [\n 123\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.artemis.cynopsis.co/api/own-restricted-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"listName\": \"<string>\",\n \"active\": true,\n \"domainIds\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artemis.cynopsis.co/api/own-restricted-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listName\": \"<string>\",\n \"active\": true,\n \"domainIds\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"createdAt": {
"date": 123,
"day": 123,
"hours": 123,
"minutes": 123,
"month": 123,
"nanos": 123,
"seconds": 123,
"time": 123,
"timezoneOffset": 123,
"year": 123
},
"createdBy": {
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastName": "<string>"
},
"domains": [
{
"id": 123,
"name": "<string>"
}
],
"id": 123,
"listName": "<string>",
"nameOnList": 123,
"updatedAt": {
"date": 123,
"day": 123,
"hours": 123,
"minutes": 123,
"month": 123,
"nanos": 123,
"seconds": 123,
"time": 123,
"timezoneOffset": 123,
"year": 123
},
"updatedBy": {
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastName": "<string>"
}
}Own Restricted List APIs
Post New Restricted List
POST
/
api
/
own-restricted-list
createList
curl --request POST \
--url https://api.artemis.cynopsis.co/api/own-restricted-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"listName": "<string>",
"active": true,
"domainIds": [
123
]
}
'import requests
url = "https://api.artemis.cynopsis.co/api/own-restricted-list"
payload = {
"listName": "<string>",
"active": True,
"domainIds": [123]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({listName: '<string>', active: true, domainIds: [123]})
};
fetch('https://api.artemis.cynopsis.co/api/own-restricted-list', 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.artemis.cynopsis.co/api/own-restricted-list",
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([
'listName' => '<string>',
'active' => true,
'domainIds' => [
123
]
]),
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://api.artemis.cynopsis.co/api/own-restricted-list"
payload := strings.NewReader("{\n \"listName\": \"<string>\",\n \"active\": true,\n \"domainIds\": [\n 123\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.artemis.cynopsis.co/api/own-restricted-list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"listName\": \"<string>\",\n \"active\": true,\n \"domainIds\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artemis.cynopsis.co/api/own-restricted-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listName\": \"<string>\",\n \"active\": true,\n \"domainIds\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"createdAt": {
"date": 123,
"day": 123,
"hours": 123,
"minutes": 123,
"month": 123,
"nanos": 123,
"seconds": 123,
"time": 123,
"timezoneOffset": 123,
"year": 123
},
"createdBy": {
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastName": "<string>"
},
"domains": [
{
"id": 123,
"name": "<string>"
}
],
"id": 123,
"listName": "<string>",
"nameOnList": 123,
"updatedAt": {
"date": 123,
"day": 123,
"hours": 123,
"minutes": 123,
"month": 123,
"nanos": 123,
"seconds": 123,
"time": 123,
"timezoneOffset": 123,
"year": 123
},
"updatedBy": {
"email": "<string>",
"firstName": "<string>",
"fullName": "<string>",
"id": 123,
"lastName": "<string>"
}
}This endpoint allows you to create a new Own Restricted List entry.
Restricted list entries are tied to one or more domain IDs, ensuring they apply only within the specified domains.
Restricted list entries are tied to one or more domain IDs, ensuring they apply only within the specified domains.
Request Body
A JSON object containing the details of the restricted entry:listName— Name of the restricted entity or keyword.domainIds— Array of domain IDs where this restricted entry should apply.active— Making the ORL active or inactive.
Notes
- You must specify at least one domainId in the request body.
- Multiple domain IDs can be provided if the entry is meant to be shared across different domains.
Authorizations
OAuth2_Client_CredentialsOAuth2_Password
The access token received from the authorization server in the OAuth 2.0 flow.
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
