Create script
https://{kibana_url}
- POST /api/endpoint/scripts_library
- POST /s/{space_id}/api/endpoint/scripts_library
Refer to Spaces for more information.
Create a new script entry by uploading a script file
Request
-
descriptionstring · max: 10000 -
Description of the script and its purpose/functionality
-
examplestring · max: 10000 -
Example usage of the script
-
fileobjectrequired -
The script file upload
-
fileType -
The type of the uploaded file, which determines the expected value of
pathToExecutable. IffileTypeis "script", thenpathToExecutableshould not be included. IffileTypeis "archive", thenpathToExecutableis required and should specify the path to the executable file within the archive. -
Values:
scriptarchive -
instructionsstring · max: 10000 -
Instructions for using the script, including details around its supported input arguments
-
namestring · min: 1 · max: 256required -
Name of the script
-
pathToExecutablestring · max: 4096 -
Used only for when the uploaded script is an archive (.zip file for example). This property defines the relative path to the file included in the archive that should be executed once its contents are extracted. The path should be relative to the root of the archive.
-
requiresInputboolean -
Whether the script requires input arguments
-
Tags to categorize the script
-
Values:
remediationActiondataCollectionnetworkDiagnosticsnetworkActionsystemInventoryforensicCollectionthreatHuntingdiscoverysystemManagementuserManagementtroubleshooting
Response
Action request was successfully created
-
data -
createdAtstring -
createdBystring -
descriptionstring -
Description of the script and its purpose/functionality
-
downloadUristring -
URI to download the script file. Note that this is the relative path and does not include the space (if applicable)
-
examplestring -
fileHashstring -
SHA256 hash of the script file that was uploaded
-
fileNamestring -
Name of the script file that was uploaded
-
fileSizeinteger -
Size of the script file that was uploaded in bytes
-
idstring -
instructionsstring -
Instructions for using the script, including details around its supported input arguments
-
namestring -
pathToExecutablestring -
The relative path to the file included in the archive that should be executed once its contents are extracted. Applicable only for scripts uploaded as an archive (.zip file for example).
-
platform -
Values:
linuxmacoswindows -
requiresInputboolean -
Tags that categorize the script
-
Values:
remediationActiondataCollectionnetworkDiagnosticsnetworkActionsystemInventoryforensicCollectionthreatHuntingdiscoverysystemManagementuserManagementtroubleshooting -
updatedAtstring -
updatedBystring -
versionstring