Scripts: Edit
Description
Modify the attributes of a Script.
HTTP Request
PATCH /api/v1beta0/user/envId/scripts/scriptId/Parameters
| Name | Required | Description | Location |
|---|---|---|---|
| envId integer |
Yes | The ID of the Environment scoping this request. |
path |
| scriptId integer |
Yes | The ID of a Script object. |
path |
Request body
The JSON representation of a Script object.
The body must be a valid Script object. Example value:
{
"blockingDefault": true,
"deprecated": true,
"description": "string",
"name": "string",
"requireAdminPrivileges": true,
"tags": [
"string"
],
"timeoutDefault": 1,
"variables": [
{
"category": "string",
"description": "string",
"hidden": true,
"locked": true,
"required": true,
"value": "string"
}
]
}Successful Response (Status 200)
The JSON representation of a Script object.
The API replies with a ScriptDetailsResponse object. Example response body:
{
"data": {
"added": "2013-01-01T12:34:56.789Z",
"blockingDefault": true,
"deprecated": true,
"description": "string",
"id": 1,
"lastChanged": "2013-01-01T12:34:56.789Z",
"name": "string",
"osType": "linux",
"requireAdminPrivileges": true,
"scope": "scalr",
"tags": [
"string"
],
"timeoutDefault": 1,
"variables": [
{
"category": "string",
"description": "string",
"hidden": true,
"locked": true,
"name": "string",
"required": true,
"type": "ScriptVariable",
"value": "string"
}
]
},
"errors": [
{
"code": "string",
"message": "string"
}
],
"meta": {
"sample": "string"
},
"warnings": [
{
"code": "string",
"message": "string"
}
]
}Other Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | A client-side error was made. |
An ApiErrorResponse object |
| 401 | The request was not authenticated. |
An ApiErrorResponse object |
| 403 | Insufficient permissions. |
An ApiErrorResponse object |
| 404 | Resource not found. |
An ApiErrorResponse object |
| 409 | Conflict with current state. |
An ApiErrorResponse object |
| 422 | This request was well-formed but was rejected due to semantic errors. |
An ApiErrorResponse object |
| 500 | A server-side error occurred. |
An ApiErrorResponse object |
| 501 | This feature is not implemented in Scalr. |
An ApiErrorResponse object |
| 503 | The service is currently unavailable. |
An ApiErrorResponse object |