Get a StackScript

get https://api.linode.com/{apiVersion}/linode/stackscripts/{stackscriptId}

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

linode-cli stackscripts view 10079


Learn more...

stackscripts:read_only


Learn more...

Responses

Response body

object

created

date-time

Read-only The date this StackScript was created.

deployments_active

integer

Read-only Count of currently active, deployed Linodes created from this StackScript.

deployments_total

integer

Filterable, Read-only The total number of times this StackScript has been deployed.

description

string

Filterable A description for the StackScript.

integer

Read-only The unique ID of this StackScript.

images

array of strings

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.

images

is_public

boolean

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

label

string

length between 3 and 128

Filterable The StackScript's label is for display purposes only.

mine

boolean

Filterable, Read-only Returns true if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript.

rev_note

string

Filterable 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

date-time

Read-only The date this StackScript was last updated.

user_defined_fields

array of objects

Read-only 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_defined_fields

object

default

string

Read-only The default value. If not specified, this value will be used.

example

string

required

Read-only An example value for the field.

label

string

required

Read-only A human-readable label for the field that will serve as the input prompt for entering the value during deployment.

manyOf

string

Read-only A list of acceptable values for the field in any quantity, combination or order.

name

string

required

Read-only The name of the field.

oneOf

string

Read-only A list of acceptable single values for the field.

user_gravatar_id

string

Read-only The Gravatar ID for the User who created the StackScript.

username

string

Read-only The User who created the StackScript.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/linode/stackscripts/stackscriptId \
3
     --header 'accept: application/json'


xxxxxxxxxx
24
 
1
{
2
  "created": "2018-01-01T00:01:01",
3
  "deployments_active": 1,
4
  "deployments_total": 12,
5
  "description": "This StackScript installs and configures MySQL",
6
  "id": 10079,
7
  "images": [
8
    "linode/debian9",
9
    "linode/debian8"
10
  ],
11
  "is_public": true,
12
  "label": "a-stackscript",
13
  "mine": true,
14
  "rev_note": "Set up MySQL",
15
  "script": "\\\"#!/bin/bash\\\"",
16
  "updated": "2018-01-01T00:01:01",
17
  "user_defined_fields": {
18
    "example": "hunter2",
19
    "label": "Enter the DB password",
20
    "name": "DB_PASSWORD"
21
  },
22
  "user_gravatar_id": "a445b305abda30ebc766bc7fda037c37",
23
  "username": "myuser"
24
}

200A single StackScript.

defaultSee Errors for the range of possible error response codes.