Lists

Download OpenAPI specification:Download

Lists APIs provided by Detection and Response services are used to organize recommendations into categories and manage them.

Create list

Creates a new recommendation list.

SecurityHTTP: risk_access_token
Request
Request Body schema: application/json
required
list_name
required
string

The list title.

list_type
required
string (list_type)

The type of recommendation list.

Value: "action_id"
creator
required
string

The list owner.

Responses
201

List

400

Bad request

401

Invalid authentication

403

Invalid authorization (e.g, unauthorized resource)

409

Unique field collision

429

Rate limit reached

500

Internal error

post/lists
Request samples
application/json
{
  • "list_name": "string",
  • "list_type": "action_id",
  • "creator": "string"
}
Response samples
application/json
{
  • "list_name": "string",
  • "tenant_id": "string",
  • "list_type": "action_id",
  • "creator": "string",
  • "list_id": "string",
  • "items": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "updated_date": "2019-08-24T14:15:22Z"
}

Get all lists

Retrieves all lists of the tenant. To return lists that include a specific recommendation, add item_id to the query.

SecurityHTTP: risk_access_token
Request
query Parameters
item_id
string

ID of the list item.

Responses
200

Matching lists

400

Bad request

401

Invalid authentication

403

Invalid authorization (e.g, unauthorized resource)

404

Not found

429

Rate limit reached

500

Internal error

get/lists
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get list
Retrieves a specific list by its ID.


SecurityHTTP: risk_access_token 
Request 
path Parameters
list_id
required
string
ID of the recommendation list.


 
Responses 
200
List


400
Bad request


401
Invalid authentication


403
Invalid authorization (e.g, unauthorized resource)


404
Not found


429
Rate limit reached


500
Internal error


get/lists/{list_id}
Request samples 
Response samples 
application/json
{
  • "list_name": "string",
  • "tenant_id": "string",
  • "list_type": "action_id",
  • "creator": "string",
  • "list_id": "string",
  • "items": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "updated_date": "2019-08-24T14:15:22Z"
}
Update list
Updates a specific list. Currently, you can update a list name.


Request 
path Parameters
list_id
required
string
ID of the recommendation list.


 
query Parameters
list_name
required
string
The list title.


 
Responses 
200
List


400
Bad request


401
Invalid authentication


403
Invalid authorization (e.g, unauthorized resource)


404
Not found


409
Unique field collision


429
Rate limit reached


500
Internal error


put/lists/{list_id}
Request samples 
Response samples 
application/json
{
  • "list_name": "string",
  • "tenant_id": "string",
  • "list_type": "action_id",
  • "creator": "string",
  • "list_id": "string",
  • "items": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "updated_date": "2019-08-24T14:15:22Z"
}
Delete list
Removes a recommendation list by its ID.


Request 
path Parameters
list_id
required
string
ID of the recommendation list.


 
Responses 
200
Success


400
Bad request


401
Invalid authentication


403
Invalid authorization (e.g, unauthorized resource)


404
Not found


429
Rate limit reached


500
Internal error


delete/lists/{list_id}
Request samples 
Response samples 
application/json
{
  • "message": "string"
}
Add to list
Adds recommendations to the specific list.


Request 
path Parameters
list_id
required
string
ID of the recommendation list.


 
Request Body schema: application/json
required
item_ids
required
Array of strings
 
Responses 
201
List contents


400
Bad request


401
Invalid authentication


403
Invalid authorization (e.g, unauthorized resource)


404
Not found


409
Unique field collision


429
Rate limit reached


500
Internal error


post/lists/{list_id}/items
Request samples 
application/json
{
  • "item_ids": [
    ]
}
Response samples 
application/json
{
  • "list_id": "string",
  • "tenant_id": "string",
  • "added_date": "2019-08-24T14:15:22Z",
  • "items": [
    ]
}
Remove item from list
Removes a specific item from the list.


Request 
path Parameters
list_id
required
string
ID of the recommendation list.


 
item_id
required
string
ID of the item to be removed.


 
Responses 
200
Success


400
Bad request


401
Invalid authentication


403
Invalid authorization (e.g, unauthorized resource)


404
Not found


429
Rate limit reached


500
Internal error


delete/lists/{list_id}/items/{item_id}
Request samples 
Response samples 
application/json
{
  • "message": "string"
}