Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
Related guide: Managing list items
Attributes
-
idstring
Unique identifier for the object.
-
valuestring
The value of the item.
-
value_
liststring The identifier of the value list this item belongs to.
More attributes
- objectstring
- createdtimestamp
- created_
bystring - livemodeboolean
{
"id": "rsli_1MxxosLkdIwHu7ixxvA1yKiZ",
"object": "radar.value_list_item",
"created": 1681760074,
"created_by": "API",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1MxxosLkdIwHu7ixNiiD01Kj"
}Creates a new ValueListItem object, which is added to the specified parent value list.
Parameters
-
valuestringRequired
The value of the item (whose type must match the type of the parent value list).
The maximum length is 800 characters.
-
value_
liststringRequired The identifier of the value list which the created item will be added to.
Returns
Returns a ValueListItem object if creation succeeds.
{
"id": "rsli_1MxxosLkdIwHu7ixxvA1yKiZ",
"object": "radar.value_list_item",
"created": 1681760074,
"created_by": "API",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1MxxosLkdIwHu7ixNiiD01Kj"
}Retrieves a ValueListItem object.
Parameters
No parameters.
Returns
Returns a ValueListItem object if a valid identifier was provided.
{
"id": "rsli_1MxxosLkdIwHu7ixxvA1yKiZ",
"object": "radar.value_list_item",
"created": 1681760074,
"created_by": "API",
"livemode": false,
"value": "1.2.3.4",
"value_list": "rsl_1MxxosLkdIwHu7ixNiiD01Kj"
}Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
-
value_
liststringRequired Identifier for the parent value list this item belongs to.
-
valuestring
Return items belonging to the parent list whose value matches the specified value (using an “is like” match).
The maximum length is 800 characters.
More parameters
- createdobject
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data property that contains an array of up to limit items, starting after item starting_. Each entry in the array is a separate ValueListItem object. If no more items are available, the resulting array will be empty.
{
"object": "list",
"url": "/v1/radar/value_list_items",
"has_more": false,
"data": [
{
"id": "rsl_1MxxosLkdIwHu7ixNiiD01Kj",
"object": "radar.value_list",
"alias": "custom_ip_blocklist",
"created": 1681760074,
"created_by": "API",
"item_type": "ip_address",
"list_items": {
"object": "list",
"data": [],
"has_more": false,
"total_count": 0,
"url": "/v1/radar/value_list_items?value_list=rsl_1MxxosLkdIwHu7ixNiiD01Kj"
},
"livemode": false,
"metadata": {},
"name": "Custom IP Blocklist"
}
]
}