stackscripts
Overview
Name | stackscripts |
Type | Resource |
Id | linode.instances.stackscripts |
Fields
Name | Datatype | Description |
---|---|---|
id | integer | The unique ID of this StackScript. |
description | string | A description for the StackScript. |
created | string | The date this StackScript was created. |
deployments_active | integer | Count of currently active, deployed Linodes created from this StackScript. |
deployments_total | integer | The total number of times this StackScript has been deployed. |
images | array | An array of Image IDs. These are the Images that can be deployed with this StackScript.any/all indicates that all available Images, including private Images, are accepted. |
is_public | boolean | This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private. |
label | string | The StackScript's label is for display purposes only. |
mine | boolean | Returns true if this StackScript is owned by the account of the user making the request, and the usermaking the request is unrestricted or has access to this StackScript. |
rev_note | 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. |
updated | string | The date this StackScript was last updated. |
user_defined_fields | array | This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See Declare User-Defined Fields (UDFs) for more information. |
user_gravatar_id | string | The Gravatar ID for the User who created the StackScript. |
username | string | The User who created the StackScript. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
getStackScript | SELECT | stackscriptId | Returns all of the information about a specified StackScript, including the contents of the script. |
getStackScripts | SELECT | If the request is not authenticated, only public StackScripts are returned. For more information on StackScripts, please read our StackScripts documentation. | |
addStackScript | INSERT | data__images, data__label, data__script | Creates a StackScript in your Account. |
deleteStackScript | DELETE | stackscriptId | Deletes a private StackScript you have permission to read_write . You cannot delete a public StackScript. |
_getStackScript | EXEC | stackscriptId | Returns all of the information about a specified StackScript, including the contents of the script. |
_getStackScripts | EXEC | If the request is not authenticated, only public StackScripts are returned. For more information on StackScripts, please read our StackScripts documentation. | |
updateStackScript | EXEC | stackscriptId | Updates a StackScript. Once a StackScript is made public, it cannot be made private. |