Homepage Redirect for Confluence
Space shortcuts
Space Tools
Homepage Redirect for Confluence BVREDIRECT

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Redirect to URL
targetUrlhttps://bitvoodoo-apps.atlassian.net/wiki/spaces/BVREDIRECT/pages/9570614900/Redirect+REST+API


Table of Contents

Homepage redirect provides a REST API to create, read, update and delete redirects.

...

Localtab Group


Localtab
titleGET


Section


Column
width50%

Query parameter 

ParameterTypeRequiredDescription
idLong(tick)The  id of the redirect. 
e.g.


Endpoint example:

/rest/homepageredirect/1.0/redirect?id=42


Column
width50%

Response

Returns the redirect setting:

Code Block
languagejs
linenumberstrue
{
	"id" : 42,
	"contentId" : 65611,
	"group" : "confluence-users",
	"isAnonymous" : false
}





Localtab
titlePUT


Section


Column
width50%

JSON Attributes in Request Body 

ParameterTypeRequiredDescription
idLong(tick)The id of the redirect. 
contentIdLong(tick)The id of the page or blog. Automatically detects pages Space Homepages.
groupString
The group name or empty to update the redirect for anonymous users.



Column
width50%

Request Body:

Code Block
languagejs
linenumberstrue
{
	"id" : 42,
	"contentId" : 65611,
	"group" : "confluence-users"
}

Response

Returns the redirect setting:

Code Block
languagejs
linenumberstrue
{
	"id" : 42,
	"contentId" : 65611,
	"group" : "confluence-users",
	"isAnonymous" : false
}





Localtab
titlePOST


Section


Column
width50%

JSON Attributes in Request Body  

ParameterTypeRequiredDescription
contentIdLong(tick)The id of the page or blog. Automatically detects pages Space Homepages.
groupString
The group name or empty to create a redirect for anonymous users.



Column
width50%

Request Body:

Code Block
languagejs
linenumberstrue
{
	"contentId" : 65611,
	"group" : "confluence-users"
}

Response

Returns the redirect setting:

Code Block
languagejs
linenumberstrue
{
	"id" : 43,
	"contentId" : 65611,
	"group" : "confluence-users",
	"isAnonymous" : false
}





Localtab
titleDELETE


Section


Column
width50%

Parameters 

ParameterTypeRequiredDescription
idLong(tick)The  id of the redirect. 



Column
width50%

Response

Returns Status 200 when deleted successfully.




...

Homepage Redirect for Confluence BVREDIRECT