REST API - Space Shortcuts

1 General information
2 Get all space shortcuts
3 Create space shortcut

General information

Available since v. 3.10.0

Get all space shortcuts

Available only for Confluence Administrators and Space Administrators

Method type: GET

URL: {CONFLUENCE_URL}/rest/extender/1.0/space/{SPACE_KEY}/shortcuts

where {SPACE_KEY} is the space key

Respons format: JSON

Example response:

{
	"spaceShortcuts": [
		{
			"resourceId": "819203",
			"position": 1,
			"id": 6,
			"title": "Troubleshooting articles",
			"type": "pinned_page blueprint kb-troubleshooting-article",
			"url": "/display/ds/Troubleshooting+articles"
		},
		{
			"resourceId": "",
			"position": 2,
			"id": 7,
			"title": "www.itlab.net.pl",
			"type": "external_link",
			"url": "https://www.itlab.net.pl/"
		},
		{
			"resourceId": "98305",
			"position": 3,
			"id": 8,
			"title": "Demonstration Space",
			"type": "pinned_space",
			"url": "/display/ds"
		},
		{
			"resourceId": "65551",
			"position": 4,
			"id": 9,
			"title": "Welcome to Confluence page",
			"type": "pinned_page",
			"url": "/display/ds/Welcome+to+Confluence"
		},
		{
			"resourceId": "",
			"position": 5,
			"id": 10,
			"title": "Instruction_211104.pdf",
			"type": "pinned_attachment",
			"url": "/display/ds/Welcome+to+Confluence?preview=%2F65551%2F819205%2FSOK_P_przyklad_wniosku_o_wydanie_dowodu_osobistego_211104.pdf"
		},
		{
			"resourceId": "65590",
			"position": 6,
			"id": 11,
			"title": "User: Admin",
			"type": "pinned_profile",
			"url": "/display/~admin"
		}
	]
}

Create space shortcut

Available only for Confluence Administrators and Space Administrators

Method type: PUT

URL: {CONFLUENCE_URL}/rest/extender/1.0/space/{SPACE_KEY}/shortcut

where {SPACE_KEY} is the space key

Request format: JSON

Example request:

{
    "type":"pinned_attachment",
    "resourceId": 1441798
}

{
    "type":"pinned_profile",
    "resourceId": 1234
}

Request format: JSON

Example response:

type - required - available options “pinned_attachment”, “pinned_profile”, “pinned_page”, “external_link”

resourceId - optional / required - required for “pinned_attachment”, “pinned_profile” and “pinned_page” types (attachment id, user profile id or page id). Attribute omitted for “external_link” type.

userName - optional - only for “pinned_profile” - if you don't provide or don't know the resourceId for the user, you can provide this attribute with the username.

title - optional - if you want to use a title other than name or url for the shortcut, you can specify this parameter

url - optional / required - required “external_link” type (page url). Attribute omitted for others types. Url must start with "http://", "https://", "mailto:", "skype:", "callto:", "facetime:", "git:", "irc:", "irc6:", "news:", "nntp:", "feed:", "cvs:", "svn:", "mvn:", "ssh:", "itms:", "notes:", "smb:" or "hipchat:"