How to Retrieve an Instance Template

Retrieving an instance template returns its full configuration, including the plan, OS, and SSH keys. This is useful for reviewing a template's details before using it to create a cluster or instance.

This guide explains how to retrieve an instance template using the Vultr API.

1. Send a GET request to the List Instance Templates endpoint to retrieve all templates.

   CONSOLE

   Copy

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

   Explain Code

   Powered by Vultr AgentBeta

   Note the id of the template you want to retrieve.

2. Send a GET request to the Get Instance Template endpoint to retrieve the template details. Replace {template-id} with the template's ID.

   CONSOLE

   Copy

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

   Explain Code

   Powered by Vultr AgentBeta

   The response contains the template configuration details.