---
type: api
title: Run a script
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v8/operation/operation-runscriptaction
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v8/operation/operation-runscriptaction
products:
  - Kibana
---

# Run a script

- Server: `https://{kibana_url}`

## Paths

- `POST` `/api/endpoint/action/runscript`
- `POST` `/s/{space_id}/api/endpoint/action/runscript`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v8/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v8/authentication#basicauth)

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Run a shell command on an endpoint.

## Request Body

`application/json`

- `parameters` (union oneOf) — required
  Exactly one of 'Raw', 'HostPath', or 'CloudFile' must be provided. CommandLine and Timeout are optional for all.
  - **RawScriptParameters**
    - `commandLine` (string · min: 1) — optional
      Command line arguments.
    - `raw` (string · min: 1) — required
      Raw script content.
    - `timeout` (integer · min: 1) — optional
      Timeout in seconds.
  - **HostPathScriptParameters**
    - `commandLine` (string · min: 1) — optional
      Command line arguments.
    - `hostPath` (string · min: 1) — required
      Absolute or relative path of script on host machine.
    - `timeout` (integer · min: 1) — optional
      Timeout in seconds.
  - **CloudFileScriptParameters**
    - `cloudFile` (string · min: 1) — required
      Script name in cloud storage.
    - `commandLine` (string · min: 1) — optional
      Command line arguments.
    - `timeout` (integer · min: 1) — optional
      Timeout in seconds.

## Response

OK

`application/json`

Type: `object`

## Code Examples

#### Console

```console
POST /api/endpoint/action/runscript
```

#### curl

```curl
curl -X POST "https://{kibana_url}/api/endpoint/action/runscript"
```