StackScripts v4.78.3

StackScripts List

GET https://api.linode.com/v4/linode/stackscripts

If the request is not authenticated, only public StackScripts are returned.

For more information on StackScripts, please read our StackScripts guides.

Authorizations

personalAccessToken
oauth stackscripts:read_only

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

StackScript Create

POST https://api.linode.com/v4/linode/stackscripts

Creates a StackScript in your Account.

Authorizations

personalAccessToken
oauth stackscripts:read_write

Request Body Schema

description
Filterable
string

A description for the StackScript.

images
Required
array

An array of Image IDs. These are the images that can be deployed with this Stackscript.

is_public
Filterable
boolean

This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.

label
Filterable
Required
string 3..128 characters

The StackScript’s label is for display purposes only.

rev_note
Filterable
string

This field allows you to add notes for the set of revisions made to this StackScript.

script
Required
string

The script to execute when provisioning a new Linode with this StackScript.

Request Samples

Response Samples

Responses

StackScript Delete

DELETE https://api.linode.com/v4/linode/stackscripts/{stackscriptId}

Deletes a private StackScript you have permission to read_write. You cannot delete a public StackScript.

Authorizations

personalAccessToken
oauth stackscripts:read_write

Path Parameters

stackscriptId string Required

The ID of the StackScript to look up.

Request Samples

Response Samples

Responses

StackScript View

GET https://api.linode.com/v4/linode/stackscripts/{stackscriptId}

Returns all of the information about a specified StackScript, including the contents of the script.

Authorizations

personalAccessToken
oauth stackscripts:read_only

Path Parameters

stackscriptId string Required

The ID of the StackScript to look up.

Request Samples

Response Samples

Responses

StackScript Update

PUT https://api.linode.com/v4/linode/stackscripts/{stackscriptId}

Updates a StackScript.

Once a StackScript is made public, it cannot be made private.

Authorizations

personalAccessToken
oauth stackscripts:read_write

Path Parameters

stackscriptId string Required

The ID of the StackScript to look up.

Request Body Schema

description
Filterable
string

A description for the StackScript.

images
array

An array of Image IDs. These are the images that can be deployed with this Stackscript.

is_public
Filterable
boolean

This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.

label
Filterable
string 3..128 characters

The StackScript’s label is for display purposes only.

rev_note
Filterable
string

This field allows you to add notes for the set of revisions made to this StackScript.

script
string

The script to execute when provisioning a new Linode with this StackScript.

Request Samples

Response Samples

Responses