Update script

Server: https://{kibana_url}

PATCH /api/endpoint/scripts_library/{script_id}
PATCH /s/{space_id}/api/endpoint/scripts_library/{script_id}

Api key auth Basic auth

Refer to Spaces for more information.

Update (full or partial) a script entry

Path Parameters

script_id string · max: 256 required: The ID of the script entry to be updated.

Request

Response

Action request was successfully updated

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PATCH /api/endpoint/scripts_library/{script_id}
{
  "instructions": "./collect_host_data.sh --help"
}

curl Shell

curl -X PATCH "https://{kibana_url}/api/endpoint/scripts_library/{script_id}" \
  -H "Content-Type: multipart/form-data" \
  -d '{
  "instructions": "./collect_host_data.sh --help"
}'

Response

{
  "data": {
    "description": "Collects host data for investigation",
    "file": "./collect_host_data.sh",
    "fileType": "script",
    "id": 1234567890,
    "instructions": "No arguments required",
    "name": "Collect host data",
    "platform": [
      "linux",
      "macos"
    ]
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

PATCH /api/endpoint/scripts_library/{script_id}
{
  "fileType": "script"
}

curl Shell

curl -X PATCH "https://{kibana_url}/api/endpoint/scripts_library/{script_id}" \
  -H "Content-Type: multipart/form-data" \
  -d '{
  "fileType": "script"
}'

Response

{
  "data": {
    "description": "Collects host data for investigation",
    "file": "./collect_host_data.sh",
    "fileType": "script",
    "id": 1234567890,
    "instructions": "No arguments required",
    "name": "Collect host data",
    "platform": [
      "linux",
      "macos"
    ]
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

PATCH /api/endpoint/scripts_library/{script_id}
{
  "fileType": "archive",
  "pathToExecutable": "./bin/collect_host_data.sh"
}

curl Shell

curl -X PATCH "https://{kibana_url}/api/endpoint/scripts_library/{script_id}" \
  -H "Content-Type: multipart/form-data" \
  -d '{
  "fileType": "archive",
  "pathToExecutable": "./bin/collect_host_data.sh"
}'

Response

{
  "data": {
    "description": "Collects host data for investigation",
    "file": "./collect_host_data.sh",
    "fileType": "script",
    "id": 1234567890,
    "instructions": "No arguments required",
    "name": "Collect host data",
    "platform": [
      "linux",
      "macos"
    ]
  }
}

Path Parameters

Request { description , example , file , fileType , instructions , name , pathToExecutable , platform , requiresInput , tags , version , }

Response

Request