Scripts / Script Versions: Edit

Description

Modify the attributes of a given Script Version

HTTP Request

PATCH /api/v1beta0/account/accountId/scripts/scriptId/script-versions/scriptVersionNumber/

Parameters

Name Required Description Location
accountId
integer
Yes

The ID of the Account scoping this request.

path
scriptId
integer
Yes

The ID of a Script object.

path
scriptVersionNumber
integer
Yes

The version number of the Script Version being accessed.

path

Request body

The JSON representation of a ScriptVersion object.

The body must be a valid ScriptVersion object. Example value:

{
  "body": "string"
}

Successful Response (Status 200)

The JSON representation of a ScriptVersion object.

The API replies with a ScriptVersionDetailsResponse object. Example response body:

{
  "data": {
    "added": "2013-01-01T12:34:56.789Z", 
    "body": "string", 
    "script": {
      "id": 1
    }, 
    "version": 1
  }, 
  "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

Try it out!

Parameter Value Description
accountId

The ID of the Account scoping this request.

scriptId

The ID of a Script object.

scriptVersionNumber

The version number of the Script Version being accessed.

body

The JSON representation of a ScriptVersion object.