General informations

REST API - Templates is available since v. 1.3.*

Available since v. 2.27.0

Get all global templates

note

Available for all Confluence Users

Method type -

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/global

Response format:

{
  "templates": [
    {
      "name": "test global templates",
      "description": null,
      "title": "test global templates",
      "content": "<at:declarations /><ac:layout><ac:layout-section ac:type=\"single\"><ac:layout-cell><p>global templates body</p></ac:layout-cell></ac:layout-section><ac:layout-section ac:type=\"single\"><ac:layout-cell><table><tbody><tr><th>Row 1</th><th>Row 2</th><th>Row 3</th></tr><tr><td>A</td><td>B</td><td>C</td></tr><tr><td>Q</td><td>W</td><td>E</td></tr></tbody></table></ac:layout-cell></ac:layout-section></ac:layout>"
    }
  ]
}

Get global template by name

note

Available for all Confluence Users

Method type -

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/global/{TEMPLATE_NAME}

Response format:

{
  "template": {
    "name": "test global templates",
    "description": null,
    "title": "test global templates",
    "content": "<at:declarations /><ac:layout><ac:layout-section ac:type=\"single\"><ac:layout-cell><p>global templates body</p></ac:layout-cell></ac:layout-section><ac:layout-section ac:type=\"single\"><ac:layout-cell><table><tbody><tr><th>Row 1</th><th>Row 2</th><th>Row 3</th></tr><tr><td>A</td><td>B</td><td>C</td></tr><tr><td>Q</td><td>W</td><td>E</td></tr></tbody></table></ac:layout-cell></ac:layout-section></ac:layout>"
  }
}

Create global template

note

Available for Confluence Administrators

Method type:

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/global/create

Request format:

{
	"title": "Template title",
	"description": "Template description",
	"content": "<p>Template content</p>"
}

title - required - template title
description - optional - template description
content - optional - template content in Confluence Storage Format

Edit global template

note

Available for Confluence Administrators

Method type -

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/global/edit/{TEMPLATE_ID}

Request format:

{
	"title": "Template title",
	"description": "Template description",
	"content": "<p>Template content</p>"
}

title - optional - template title
description - optional - template description
content - optional - template content in Confluence Storage Format

Get space templates

note

Available for Confluence Administrators, space Administrators and all users with VIEW and CREATE PAGE permission in this specific space

Method type -

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/space/{SPACE_ID_OR_KEY}

Response format:

{
  "templates": [
    {
      "name": "Space template title",
      "description": null,
      "title": "Space template title",
      "content": "<at:declarations /><p>Space template body</p>"
    }
  ]
}

Create space template

note

Available for Confluence Administrators and space Administrators

Method type:

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/space/{SPACE_ID_OR_KEY}/create

Request format:

{
	"title": "Template title",
	"description": "Template description",
	"content": "<p>Template content</p>"
}

title - required - template title
description - optional - template description
content - optional - template content in Confluence Storage Format

Edit space template

note

Available for Confluence Administrators and space Administrators

Method type:

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/space/{SPACE_ID_OR_KEY}/edit/{TEMPLATE_ID}

Request format:

{
	"title": "Template title",
	"description": "Template description",
	"content": "<p>Template content</p>"
}

title - optional - template title
description - optional - template description
content - optional - template content in Confluence Storage Format

Get template by id

note

Available for Confluence Administrators, space Administrators and all users with VIEW and CREATE PAGE permission in space of this template

Method type -

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/page/{TEMPLATE_ID}

Response format:

{
  "template": {
    "name": "Space template title",
    "description": null,
    "title": "Space template title",
    "content": "<at:declarations /><p>Space template body</p>"
  }
}

Delete template by id

note

Global template - available for Confluence Administrators

Page template - available for space Administrators

Global template - available for Confluence Administrators

Page template - available for space Administrators

Method type -

URL: {CONFLUENCE_URL}/rest/extender/1.0/template/page/{TEMPLATE_ID}

Response format:

{
  "message": "Template with id '123411' has been deleted",
  "status": "success"
}