Get a list of scripts

Base URL: https://{kibana_url}

GET /api/endpoint/scripts_library

Retrieve a list of scripts

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Response

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

Base URL: https://{kibana_url}

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
}