Startup Scripts for Vultr instances are files that run custom commands when your instances boot. The scripts automate repetitive tasks like installing software, configuring settings, querying third-party services, and more. These scripts are suitable when provisioning multiple Cloud Compute instances because they save time.
Follow this guide to manage Startup Scripts for Vultr Instances using the Vultr Customer Portal, API, and CLI.
Navigate to Orchestration and select Scripts.
Click Add Startup Script.
Enter a name, select the type, define some commands, and click Add Script.
Send a POST
request to the Create Startup Script endpoint and encode the Startup script to Base64 format.
$ curl "https://api.vultr.com/v2/startup-scripts" \
-X POST \
-H "Authorization: Bearer ${VULTR_API_KEY}" \
-H "Content-Type: application/json" \
--data '{
"name" : "Sample-Script",
"type" : "pxe",
"script" : "QmFzZTY0IEV4YW1wbGUgRGF0YQ=="
}'
Visit the Create Startup Script endpoint to view additional attributes to add to your request.
Send a GET
request to the List Startup Scripts endpoint to view all scripts.
$ curl "https://api.vultr.com/v2/startup-scripts" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Create a new scripts.yaml
file.
$ nano scripts.yaml
Enter your Startup scripts into the file.
mkdir ~/my-apps
chmod 700 ~/my-apps
Save the file.
Convert the file contents to Base64 and note the output. For instance, bWtkaXIgfi9teS1hcHBzCmNobW9kIDcwMCB+L215LWFwcHM=
.
$ echo -n "$(<scripts.yaml)" | base64
Create a new Startup script.
$ vultr-cli script create \
--name Sample-Script \
--type boot \
--script bWtkaXIgfi9teS1hcHBzCmNobW9kIDcwMCB+L215LWFwcHM=
List all scripts.
$ vultr-cli script list
Get the details of a specific script by specifying a script ID.
$ vultr-cli script get script_id
Run vultr-cli script create --help
to view all options.