Get value list items
https://{kibana_url}
- GET /api/lists/items/_find
Get all value list items in the specified list.
Query Parameters
-
list_idstring · min: 1required Parent value list's
idto page through items for.-
pageinteger The page number to return.
-
per_pageinteger The number of list items to return per page.
-
sort_fieldstring · min: 1 Determines which field is used to sort the results.
-
cursorstring · min: 1 Opaque cursor returned in a previous response; pass it to continue listing from the next page. Omit on the first request.
-
filterstring Filters the returned results according to the value of the specified field, using the
Responses
Successful response
-
cursorstring · min: 1required -
Returns the items that come after the last item returned in the previous call (use the
cursorvalue returned in the previous call). This parameter uses thetie_breaker_idfield to ensure all items are sorted and returned correctly. -
dataobjectrequired -
_versionstring -
The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version.
-
@timestampstring -
created_atstringrequired -
Autogenerated date of object creation.
-
created_bystringrequired -
Autogenerated value - user that created object.
-
idstring · min: 1required -
Value list item's identifier.
-
list_idstring · min: 1required -
Value list's identifier.
-
metaobject -
Placeholder for metadata about the value list item.
-
tie_breaker_idstringrequired -
Field used in search to ensure all containers are sorted and returned correctly.
-
typerequired -
Specifies the Elasticsearch data type of excludes the list container holds. Some common examples:
keyword: Many ECS fields are Elasticsearch keywordsip: IP addressesip_range: Range of IP addresses (supports IPv4, IPv6, and CIDR notation)
-
Values:
binarybooleanbytedatedate_nanosdate_rangedoubledouble_rangefloatfloat_rangegeo_pointgeo_shapehalf_floatintegerinteger_rangeipip_rangekeywordlonglong_rangeshapeshorttext -
updated_atstringrequired -
Autogenerated date of last object update.
-
updated_bystringrequired -
Autogenerated value - user that last updated object.
-
valuestring · min: 1required -
The value used to evaluate exceptions.
-
pageinteger · min: 0required -
per_pageinteger · min: 0required -
totalinteger · min: 0required
Invalid input data response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
-
messagestringrequired -
status_codeintegerrequired
Unsuccessful authentication response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
Not enough privileges response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
Internal server error response
-
messagestringrequired -
status_codeintegerrequired