Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions docs/Contributing/API-for-contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -2726,39 +2726,6 @@ If the Fleet instance is provided required parameters to complete setup.

## Scripts

### Run script asynchronously

_Available in Fleet Premium_

Creates a script execution request and returns the execution identifier to retrieve results at a later time.

`POST /api/v1/fleet/scripts/run`

#### Parameters

| Name | Type | In | Description |
| ---- | ------- | ---- | -------------------------------------------- |
| host_id | integer | body | **Required**. The ID of the host to run the script on. |
| script_id | integer | body | The ID of the existing saved script to run. Only one of either `script_id` or `script_contents` can be included in the request; omit this parameter if using `script_contents`. |
| script_contents | string | body | The contents of the script to run. Only one of either `script_id` or `script_contents` can be included in the request; omit this parameter if using `script_id`. |

> Note that if both `script_id` and `script_contents` are included in the request, this endpoint will respond with an error.

#### Example

`POST /api/v1/fleet/scripts/run`

##### Default response

`Status: 202`

```json
{
"host_id": 1227,
"execution_id": "e797d6c6-3aae-11ee-be56-0242ac120002"
}
```

### Batch-apply scripts

_Available in Fleet Premium_
Expand Down
Loading