Reputation v2 Override Lists

Override Lists in the Reputation Service are typically allow lists (whitelists) or deny lists (blacklists) for Observations. They are used to manage the Overrides we maintain in Argus in a structured way.

Concepts

Configurable Read and Write Functions

The read and write functions on an Override List serves as a configurable way to change the access control of the individual Override Lists.

Creating an Override List

POST /reputation/v2/overrideList

Access Control

To create an Override List in Argus, the user needs to be granted the addReputationOverrideList Argus function.

Additionally, the user needs to be granted the read and write function specified in the request.

Example

curl -X POST 'https://api.mnemonic.no/reputation/v2/overrideList' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Argus-API-Key: my/api/key' \
  -d '{
  "shortName": "myOverrideList",
  "name": "My Override List",
  "description": "This is my Override List",
  "listType": "allow",
  "writeFunction": "addReputationOverrideList",
  "readFunction": "viewReputationOverrideLists", 
  "useForReputationCalc": true,
  "useForInputFiltering": true
  }'

Updating an Override List

PUT /reputation/v2/overrideList/{idOrShortName}

No fields are required, only specify the fields you want to update.

Access Control

To update an Override List in Argus, the user needs to be granted the updateReputationOverrideList Argus function.

Additionally, the user needs to be granted the read and write function specified in the request if set.

Example

curl -X PUT 'https://api.mnemonic.no/reputation/v2/overrideList/myOverrideList' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Argus-API-Key: my/api/key' \
  -d '{
  "name": "My override list",
  "description": "This is my override list",
  "listType": "deny",
  "writeFunction": "addReputationOverrideList",
  "readFunction": "viewReputationOverrideLists", 
  "useForReputationCalc": true,
  "useForInputFiltering": true
  }'

Deleting an Override List

DELETE /reputation/v2/overrideList/{idOrShortName}

Access control

To delete an Override List in Argus, the user needs to be granted the deleteReputationOverrideList Argus function.

Example

curl -X DELETE 'https://api.mnemonic.no/reputation/v2/overrideList/myOverrideList' \
  -H 'Content-Type: application/json' \
  -H 'Argus-API-Key: my/api/key'

Fetching an Override List

• GET /reputation/v2/overrideList/{idOrShortName}

Access control

To fetch an Override Lists in Argus, the user needs to be granted the viewReputationOverrideLists Argus function.

Example

curl -X GET 'https://api.mnemonic.no/reputation/v2/overrideList/myOverrideList' \
  -H 'Content-Type: application/json' \
  -H 'Argus-API-Key: my/api/key'

Listing override lists

• GET /reputation/v2/overrideList

Access control

To list Override Lists in Argus, the user needs to be granted the viewReputationOverrideLists Argus function. Additionally, only overrideLists where the user has access to its read function will be returned

Example

curl -X GET 'https://api.mnemonic.no/reputation/v2/overrideList' \
  -H 'Content-Type: application/json' \
  -H 'Argus-API-Key: my/api/key'

Searching for override lists

• POST /reputation/v2/overrideList/search

Available search terms:

• shortName

• name

• description

Access Control

To search for Override Lists in Argus, the user needs to be granted the viewReputationOverrideLists Argus function. Additionally, only overrideLists where the user has access to its read function will be returned.

Example

curl -X POST 'https://api.mnemonic.no/reputation/v2/overrideList/search' \
  -H 'Content-Type: application/json' \
  -H 'Argus-API-Key: my/api/key' \
  -d '{
  "keywords": ["myOverrideList"]
  }'