/templates/{template_id}/info

Authorizations

X-API-KEY

string

header

required

Path Parameters

template_id

string

required

The template ID

Response

200 - application/json

string

required

Unique identifier for the template, generated by Shadeform

name

string

required

Name of the template

alert

object

Set a date or spend threshold to receive an email alert

author

string

Author of the template

auto_delete

object

Set a date or spend threshold to automatically delete the instance

description

string

Description of the template

envs

object[]

List of environment variable name and values to automatically add to the instance

launch_configuration

object

Defines automatic actions after the instance becomes active.

launch_configuration.type

enum<string>

required

Specifies the type of launch configuration. See Launch Configuration for more details.

Available options:

docker,

script

launch_configuration.docker_configuration

object

May only be used if launch_configuration.type is 'docker'. Use docker_configuration to automatically pull and run a docker image. See this tutorial for examples.

launch_configuration.script_configuration

object

May only be used if launch_configuration.type is 'script'. Configures a startup script to be run automatically after the instance is active. See this [tutorial]/guides/startupscript) for examples.

logo

string

URL to the template's logo

networking

object

Network and firewall configuration

public

boolean

Whether the template is publicly available

Instances

SSH Keys

Volumes

Templates

API Documentation

Authorizations

Path Parameters

Response