Skip to main content
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 '{
  "active": true,
  "domainIds": [
    123
  ],
  "listName": "<string>"
}'
{
  "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.

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

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

request

listName
string
required
active
boolean
domainIds
integer[]

Response

OK

active
boolean
createdAt
object
createdBy
object
domains
DomainDto · object[]
id
integer
listName
string
nameOnList
integer
updatedAt
object
updatedBy
object