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

The ENDPOINT is /rest/homepageredirect/1.0/

redirect

The endpoint to manage redirects.

Resource url:  /rest/homepageredirect/1.0/redirect

Methods:    





Query parameter 

ParameterTypeRequiredDescription
idLong(tick)The  id of the redirect. 

e.g. /rest/homepageredirect/1.0/redirect?id=42


Response

Returns the redirect setting:

{
	"id" : 42,
	"contentId" : 65611,
	"group" : "confluence-users",
	"isAnonymous" : false
}







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.



Request Body:

{
	"id" : 42,
	"contentId" : 65611,
	"group" : "confluence-users"
}

Response

Returns the redirect setting:

{
	"id" : 42,
	"contentId" : 65611,
	"group" : "confluence-users",
	"isAnonymous" : false
}







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.



Request Body:

{
	"contentId" : 65611,
	"group" : "confluence-users"
}

Response

Returns the redirect setting:

{
	"id" : 43,
	"contentId" : 65611,
	"group" : "confluence-users",
	"isAnonymous" : false
}







Parameters 

ParameterTypeRequiredDescription
idLong(tick)The  id of the redirect. 



Response

Returns Status 200 when deleted successfully.




redirects

The endpoint to get all redirects.

Resource url:  /rest/homepageredirect/1.0/redirects

Methods: 



Parameters 

No parameters.


Response

[
	{
		"id": 42,
		"contentId": 65611,
		"anonymous": true
	},
	{
		"id": 43,
		"group": "confluence-users",
		"contentId": 65611,
		"anonymous": false
	}
]