Templates

This section describes the operations that are supported for templates.

Get stack template

GET /v1/{tenant_id}/stacks/{stack_name}/{stack_id}/template

Gets a template for a specified stack.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.
400	Bad Request	The request could not be understood by the server due to malformed syntax.
401	Unauthorized	The request requires user authentication.
404	Not Found	The server has not found anything matching the Request-URI.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.

Request

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The ID of the tenant. A tenant is also known as an account or project.
stack_name	String (Required)	The name of a stack.
{stack_id}	String (Required)	The stack ID.

This operation does not accept a request body.

Response

Example Get stack template: JSON response

Returns the template for the specified stack.

{
    "description": "Hello world HOT template that just defines a single server. Contains just base features to verify base HOT support.\n",
    "heat_template_version": "2013-05-23",
    "outputs": {
        "foo": {
            "description": "Show foo parameter value",
            "value": {
                "get_param": "foo"
            }
        }
    },
    "parameters": {
        "foo": {
            "default": "secret",
            "description": "Name of an existing key pair to use for the server",
            "hidden": true,
            "type": "string"
        }
    },
    "resources": {
        "random_key_name": {
            "properties": {
                "length": 8
            },
            "type": "OS::Heat::RandomString"
        }
    }
}

Validate template

POST /v1/{tenant_id}/validate

Validates a specified template.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.

Request

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The ID of the tenant. A tenant is also known as an account or project.

This table shows the body parameters for the request:

Name	Type	Description
template_url	String (Optional)	A URI to the location containing the stack template on which to perform the specified operation. See the description of the template parameter for information about the expected template content located at the URI. This parameter is only required when you omit the template parameter. If you specify both parameters, this parameter is ignored.
template	String (Optional)	The stack template on which to perform the specified operation. This parameter is always provided as a string in the JSON request body. The content of the string is a JSON- or YAML- formatted Orchestration template. For example: "template": { "heat_template_version": "2013-05-23", ...} This parameter is required only when you omit the template_url parameter. If you specify both parameters, this value overrides the template_url parameter value.
environment	String (Optional)	A JSON environment for the stack.

Example Validate template: JSON request

{
    "template_url": "/PATH_TO_HEAT_TEMPLATES/WordPress_Single_Instance.template"
}

Response

This table shows the body parameters for the response:

Name	Type	Description
Description	String (Required)	The description specified in the template.
Parameters	Object (Required)	An object that defines all input parameters that are defined in the template. Indexed by parameter name.
ParameterGroups	List (Optional)	A list of parameter groups. Each group contains a list of parameter names.

Example Validate template: JSON response

{
    "Description": "A template that provides a single server instance.",
    "Parameters": {
        "server-size": {
            "default": "1GB Standard Instance",
            "description": "Server size",
            "type": "String",
            "constraints": [
                {
                    "allowed_values": [
                        "512MB Standard Instance",
                        "1GB Standard Instance",
                        "4GB Standard Instance",
                        "8GB Standard Instance"
                    ],
                    "description": "Must be a valid server size."
                }
            ]
        },
        "key_name": {
            "description": "Keypair name for SSH access to the server",
            "required": true,
            "type": "String"
        },
        "server_name": {
            "default": "My server",
            "description": "My server",
            "type": "String"
        }
    },
    "ParameterGroups": [
        {
            "label": "Parameter groups",
            "description": "My parameter groups",
            "parameters": [
                "param_name-1",
                "param_name-2"
            ]
        }
    ]
}