Get a list of scripts

Auth

Retrieve a list of scripts

Query parameters

page integer · min: 1 · default: 1: Page number of the results to return. Defaults to 1.
pageSize integer · min: 1 · max: 1000 · default: 10: Number of results to return per page. Defaults to 10. Max value is 1000.
sortField enum: The field to sort the results by. Defaults to name.; Values: name createdAt createdBy updatedAt updatedBy fileSize
sortDirection enum: The direction to sort the results by. Defaults to asc (ascending).; Values: asc desc
kuery string: A KQL query string to filter the list of scripts. Nearly all fields in the script object are searchable.

List of scripts response

application/json

data object[]
page integer · min: 1 · default: 1: Page number
pageSize integer · min: 1 · max: 1000 · default: 10: Number of items per page
sortDirection enum: Determines the sort order.; Values: asc desc
sortField enum: Determines which field is used to sort the results.; Values: name createdAt createdBy updatedAt updatedBy fileSize
total integer: The total number of scripts matching the query

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/endpoint/scripts_library

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/endpoint/scripts_library" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "data": [],
  "page": 1,
  "pageSize": 10,
  "sortDirection": "asc",
  "sortField": "name",
  "total": 100
}