Contents

GET [/instances/$INSTANCE]/private/templates#

This is used to return the list of all the templates.

Required permission: templates-read

Response:

200 OK:

The backend has successfully returned all the templates. Returns a TemplateSummaryResponse.

404 Not found:

The backend has does not know about the instance.

Details:

interface TemplateSummaryResponse {

  // List of templates that are present in our backend.
  templates: TemplateEntry[];
}

The TemplateEntry object describes a template. It has the following structure:

interface TemplateEntry {

  // Template identifier, as found in the template.
  template_id: string;

  // Human-readable description for the template.
  template_description: string;

}