Files

56 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2022-09-02 15:09:13 -07:00
---
layout: default
title: Delete Script
parent: Script APIs
nav_order: 4
---
# Delete script
**Introduced 1.0**
{: .label .label-purple }
2022-09-02 15:09:13 -07:00
Deletes a stored script
## Path parameters
2022-09-02 15:09:13 -07:00
Path parameters are optional.
| Parameter | Data type | Description |
2022-09-02 15:09:13 -07:00
:--- | :--- | :---
| script-id | String | ID of script to delete. |
## Query parameters
2022-09-02 15:09:13 -07:00
| Parameter | Data type | Description |
2022-09-02 15:09:13 -07:00
:--- | :--- | :---
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the cluster manager. Optional, defaults to `30s`. |
| timeout | Time | The period of time to wait for a response. If a response is not received before the timeout value, the request will be dropped.
2023-02-20 11:34:20 -05:00
#### Example request
2022-09-02 15:09:13 -07:00
The following request deletes the `my-first-script` script:
````json
DELETE _scripts/my-script
````
{% include copy-curl.html %}
2022-09-02 15:09:13 -07:00
2023-02-20 11:34:20 -05:00
#### Example response
2022-09-02 15:09:13 -07:00
The `DELETE _scripts/my-first-script` request returns the following field:
````json
{
"acknowledged" : true
}
````
2022-10-27 11:50:39 -05:00
To determine whether the stored script was successfully deleted, use the [Get stored script]({{site.url}}{{site.baseurl}}/api-reference/script-apis/get-stored-script/) API, passing the script name as the `script` path parameter.
2022-09-02 15:09:13 -07:00
## Response fields
2022-09-02 15:09:13 -07:00
The <HTTP METHOD> <endpoint> request returns the following response fields:
| Field | Data type | Description |
2022-09-02 15:09:13 -07:00
:--- | :--- | :---
| acknowledged | Boolean | Whether the delete script request was received. |