How to Create an Instance Template From an Instance

Creating an instance template from an existing instance captures that instance's plan, OS, and configuration, including its marketplace app, SSH keys, startup script, and user data. For a Cloud Compute instance, it also captures the ISO. This is the only way to get a template with a startup script attached, since creating a template from scratch does not accept one.

This guide explains how to create an instance template from an existing instance using the Vultr API.

1. Send a GET request to the List Instances endpoint to retrieve all instances.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/instances" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Note the id of the instance you want to create a template from.

2. Send a POST request to the Create Instance Template From Instance endpoint. Replace {instance-id} with the instance's ID.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/instances/templates/from-instance/{instance-id}" \
       -X POST \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   A successful request returns an HTTP 200 OK response with an array containing the new template's details, the same response shape as Create Instance Template. The new template is permanent, not ephemeral.