Blueprint Maker REST API

Content Layer

name	Page Info
id	821023944
class	watermark-layer

Content Column

name	Page Body
width	100.00002%
id	821023946

Content Block

background-color	transparent
name	Prompt
rich-link-hovers	true
id	821023943
class	tight reference-prompt-flex

Create spaces and pages from Blueprints programmatically using the REST API.

Content Block

name	Reference
rich-link-hovers	true
id	1434454811
class	page-pattern-heading reference-reference-flex

REST API Requirements

REST API endpoints were added to Blueprint Maker version 2.0+ to allow:

creating new content using a defined blueprint (page, page tree, or space, as defined by the blueprint)
updating an existing page using a defined blueprint (single page blueprints only)

These will function the same as if a creating a Blueprint from the Blueprint Maker wizard menu.

The Blueprint Maker REST API can be used in conjunction with the existing Confluence REST API. For example,

Open Links in New Window
Add Attachments Add Labels Add Content

REST API Usage

Requests

Method	Endpoint	Action
PUT	/rest/blueprintmaker/1.0/createspace	create new space
PUT	/rest/blueprintmaker/1.0/createpage	create new page
PUT	/rest/blueprintmaker/1.0/copyspace	copy space
PUT	/rest/blueprintmaker/1.0/copypage	copy page
POST	/rest/blueprintmaker/1.0/updatepage/{pageid}	regenerate an existing page

Note: For curl requests, you must first create a Personal Access Token. Please see the Atlassian Confluence documentation for the latest information. Once you generate a token, copy it and keep it somewhere safe. Paste this token wherever you see YOURTOKEN in the examples below.

Data

Expects a valid JSON object. Please see the examples below.

Responses

Status

colour	Green
title	Status: 200

- Ajax request, application/json

Code Block

language	js

{
	"pageId" : 1234567	// page ID of single page created or updated, or root of page tree, or space home page
}

Status

colour	Green
title	Status: 200

- curl request, application/xml

Code Block

language	xml

<xml version="1.0" encoding="UTF-8" standalone="yes"><results><pageId>12345678</pageId></results>

Status

colour	Red
title	Status: 403

- Caller lacks permission to edit/create pages in the destination space, or a multi-page blueprint was specified (PUT request).

Status

colour	Red
title	Status: 404

- The specified blueprint, destination page (PUT request), or destination parent page doesn't exist or caller lacks view permission.

Examples

Create Space (JQuery Ajax)

Code Block

language	js

var data = {
	blueprint: {
		name: "Project Space"
	},
	destination: {
		spaceKey: "sunset",
		spaceName: "Sunset Hills",
		spaceDescription: "Everything you need to know about the Sunset Hills project."
	},
	fields: [
		{
            name: "project-name",
            value: "Sunset Hills Estates"
        },
        {
            name: "location",
            value: "432 West Elm"
        }
	]
};
$.ajax({ 
	url: "/rest/blueprintmaker/1.0/createspace", 
	data : JSON.stringify(data), 
	type: "PUT", 
	success: function(r) {console.log(r);}, error: function(x,s,t) {console.log(x,s,t);}, 
	dataType: "json"
});

Create Space (curl)

Note: for all curl examples, replace YOURTOKEN with your Personal Access Token. Replace BASEURL with your server or data center base url (e.g. "https://company.wiki.com"), and PAGEID with the page ID (e.g. "12345678"), where applicable.

Code Block

language	bash

curl -X PUT -H "Authorization:Bearer YOURTOKEN" -H "Content-Type:application/json" -d '{ "blueprint":{"name":"Project Space", "spaceKey":"projectblueprint"}, "destination": {"spaceKey":"sunset", "spaceName":"Sunset Hills", "spaceDescription":"Everything you need to know about the Sunset Hills project."}, "fields":[{"name":"project-name", "value":"Sunset Hills Estates"}, {"name":"location", "value":"432 West Elm"}] }' BASEURL/rest/blueprintmaker/1.0/createspace

Create Page (JQuery Ajax)

Code Block

language	js

var data = {
    blueprint: {
        name: "Project Page"
    },
    destination: {
        spaceKey: "project",
        pageTitle: "Project [[project-number]] - [[project-name]]",
        parentPageTitle: "Projects Home"
    },
    fields: [
        {
            name: "project-number",
            value: "23445"
        },
        {
            name: "project-name",
            value: "Sunset Hills"
        },
        {
            name: "location",
            value: "432 West Elm"
        },
        {
            name: "site-manager-name",
            value: "Susan Clarke"
        },
        {
            name: "site-manager-phone",
            value: "(123) 555-4433"
        },
        {
            name: "completion-date",
            value: "11/30/2019"
        }
    ]
};
$.ajax({
    url: "/rest/blueprintmaker/1.0/createpage",
    data : JSON.stringify(data),
    type: "PUT",
    success: function(r) {console.log(r);}, error: function(x,s,t) {console.log(x,s,t);},
    dataType: "json"
});

Create Page (curl)

Code Block

language	bash

curl -X PUT -H "Authorization:Bearer YOURTOKEN" -H "Content-Type:application/json" -d '{ "blueprint":{"name":"Project Page"}, "destination": {"spaceKey":"project", "pageTitle":"Project [[project-number]] - [[project-name]]", "parentPageTitle":"Projects Home"}, "fields":[{"name":"project-number", "value":"23445"}, {"name":"project-name", "value":"Sunset Hills"}, {"name":"location", "value":"432 West Elm"}, {"name":"site-manager-name", "value":"Susan Clarke"}, {"name":"site-manager-phone", "value":"(123) 555-443"}, {"name":"completion-date", "value":"11/30/2019"}] }' BASEURL/rest/blueprintmaker/1.0/createpage

Copy Space (JQuery Ajax)

Code Block

language	js

var data = {
	source: {
		spaceKey: "sunset"
	},
	destination: {
		spaceKey: "seaside",
		spaceName: "Seaside Project",
		spaceDescription: "Everything you need to know about the Seaside project."
	}
};
$.ajax({ 
	url: "/rest/blueprintmaker/1.0/copyspace", 
	data : JSON.stringify(data), 
	type: "PUT", 
	success: function(r) {console.log(r);}, error: function(x,s,t) {console.log(x,s,t);}, 
	dataType: "json"
});

Copy Space (curl)

Code Block

language	bash

curl -X PUT -H "Authorization:Bearer YOURTOKEN" -H "Content-Type:application/json" -d '{ "source":{"spaceKey":"sunset"}, "destination": {"spaceKey":"seaside", "spaceName":"Seaside Project", "spaceDescription":"Everything you need to know about the Seaside project."} }' BASEURL/rest/blueprintmaker/1.0/copyspace

Copy Page

Code Block

language	js

var data = {
	source: {
		spaceKey: "sunset",
		pageTitle: "Sunset Information"
	},
	destination: {
		spaceKey: "sunset",
		pageTitle: "Sunset Site Details"
	}
};
$.ajax({ 
	url: "/rest/blueprintmaker/1.0/copypage", 
	data : JSON.stringify(data), 
	type: "PUT", 
	success: function(r) {console.log(r);}, error: function(x,s,t) {console.log(x,s,t);}, 
	dataType: "json"
});

Copy Page (curl)

Code Block

language	bash

curl -X PUT -H "Authorization:Bearer YOURTOKEN" -H "Content-Type:application/json" -d '{ "source":{"spaceKey":"sunset", "pageTitle":"Sunset Information"}, "destination": {"spaceKey":"sunset", "spaceName":"Sunset Site Details"} }' BASEURL/rest/blueprintmaker/1.0/copyspace

Update Page (curl)

Code Block

language	js

curl -X POST -H "Authorization:Bearer YOURTOKEN" -H "Content-Type: application/json" -d '{"blueprint":{"name":"Project Page"}, "destination":{"pageTitle":"Project [[project-number]] - [[project-name]]"}, "fields":[{"name":"project-number", "value":"23445"}, {"name":"project-name", "value":"Sunset Vista"}, {"name":"location", "value":"432 West Elm"}, {"name":"site-manager-name", "value":"Susan Hitcheson"}, {"name":"site-manager-phone", "value":"(123) 555-4433"}, {"name":"completion-date", "value":"12/31/2019"}]}' BASEURL/rest/blueprintmaker/1.0/updatepage/PAGEID

Content Layer

background-color	$lightGrayColor
name	Related
id	1407948505

Content Column

name	Related
width	100%
id	1407948506

Content Block

rich-links-hide-description	true
rich-links-hide-site-name	false
rich-link-hovers	true
rich-links-columns	4
rich-links-vertical	true
rich-links-image-height	100px
rich-links-hide-site-icon	true
rich-links-details-padding	10px
name	Related
rich-links-enable	true
rich-links-details-alignment	left
rich-links-margin	20px 30px 0 0
id	833591344
class	related-block clean reference-related-flex

Page tree

Transform Your Digital Workplace

Industry Expertise

Inform Your Strategic Direction

Redefining Work

Documentation and Support

Versions Compared

Old Version 13

New Version Current

Key

REST API Requirements

REST API Usage

Requests

Data

Responses

Examples

Create Space (JQuery Ajax)

Create Space (curl)

Create Page (JQuery Ajax)

Create Page (curl)

Copy Space (JQuery Ajax)

Copy Space (curl)

Copy Page

Copy Page (curl)

Update Page (curl)

Platform

Company

Support

Brikit Services