Table of Contents

minLevel	1
maxLevel	6
outline	false
type	list
printable	false

Get content post information

Available only for Confluence Administrators or Space Administrator

This API supports Pagination

This API supports optional parameters

...

Code Block

{
	"hasComments": false,
	"hasChildren": true,
	"lastModificationDateString": "2020-10-26 15:44:29",
	"lastPermissionModificationDate": 1727280841377,
	"lastPermissionModificationDateString": "2024-09-25 18:14:01",
	"creatorName": "not exist",
	"lastModifierName": "not exist",
	"type": "page",
	"creationDate": 1603723469341,
	"version": 1,
	"spaceKey": "ds",
	"spaceName": "Demonstration Space",
	"creationDateString": "2020-10-26 15:44:29",
	"lastModificationDate": 1603723469341,
	"name": "Welcome to Confluence",
	"hasLabels": false,
	"position": 8,
	"id": 163841,
	"hasParent": false,
	"status": "current"
}

...

Replacing the text on the content (replace all)

Available only for Confluence Administrators or Space Administrator

...

Code Block

breakoutMode	wide

{
    "find": "Jira SD”,
    "replace": “Jira SM”
}

find - required - the text you want to replace
replace - required - the text you want to replace the search text with
ignoreCase - optional - whether the search text should be case-sensitive - true or false (default)

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "ignoreCase": true,
    "numberOfReplacements": 3,
    "message": "done"
}

...

Replacing the text on all contents in the space (replace all)

Available only for Confluence Administrators or Space Administrator

Info

The replaceAll task runs a background process with an explicit logging (WARN) of which page is currently being processed.

This API can run only one instance of a background process, if . If any process is running in the background, you'll be prompted the next time you try.

The API changes and indexes pages in packages of 50 pages, so don't worry if progress stops for a long time on one package - the time of the whole process depends on the performance of the application.

...

Code Block

breakoutMode	wide

{
    "find": "Jira SD”,
    "replace": “Jira SM”
}

find - required - the text you want to replace
replace - required - the text you want to replace the search text with
ignoreCase - optional - whether the search text should be case-sensitive - true or false (default)

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "message": "API 'replaceAll' for space 'DEMO' is in progress, wait for it to finish [50 of 166]",
    "status": "waiting"
}

Check process status

Method type -

Status

colour	Green
title	GET

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "message": "API 'replaceAll' for space 'DEMO' is in progress, wait for it to finish [100 of 166]",
    "status": "in progress"
}

...

Add text to the top of the content (prepend)

Available only for Confluence Administrators or Space Administrator

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "status": "done"
}

...

Add text to the end of the content (append)

Available only for Confluence Administrators or Space Administrator

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "status": "done"
}

...

Move/reorder page

Available to all users, but the API checks the appropriate permissions

Additional information:

if the source page contains child pages, its entire tree will be moved
you can move a page between spaces

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "message": "The source page cannot be the same as the target page."
}

...

Change the creator of all contents in the space created by the user

Available only for Confluence Administrators

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "total": 5,
    "contentsSkipped": [],
    "contentsChanged": [
        786508,
        786509,
        786507,
        786514,
        786515
    ],
    "message": "success"
}

...

Change the creator of all content by id’s

Available only for Confluence Administrators

...

Code Block

breakoutMode	wide
language	actionscript3

{
    "total": 1,
    "contentsSkipped": [
        1111111,
        2222222
    ],
    "contentsChanged": [
        786506
    ],
    "message": "success"
}

Changes

...

Get the contents of a space for which the permission modification date changed on a specific date

Available only for Confluence Administrators or Space Administrator

This API supports Pagination

This API supports optional parameters

Method type:

Status

colour	Green
title	GET

URL: {CONFLUENCE_URL}/rest/extender/1.0/permission/space/{SPACE_KEY}/getContentWithPermissionModificationDate

where {SPACE_KEY} is the space key

Parameters:

lastPermissionModificationDateFrom - filter spaces by last permission modification date (last permission modification date >= this date; default value = 1900-01-01)
lastPermissionModificationDateTo - filter spaces by last permission modification date (last permission modification date <= this date; default value = current date)
dateFormat - define date format for parameters creationDateFrom, creationDateTo and for JSON output fields creationDateString, lastModificationDateString - default format ‘yyyy-MM-dd'

Example URL:

{CONFLUENCE_URL}/rest/extender/1.0/permission/space/KB/getContentWithPermissionModificationDate?lastPermissionModificationDateTo=2024-09-22
{CONFLUENCE_URL}/rest/extender/1.0/permission/space/KB/getContentWithPermissionModificationDate?lastPermissionModificationDateFrom=2022-09-22
{CONFLUENCE_URL}/rest/extender/1.0/permission/space/KB/getContentWithPermissionModificationDate?lastPermissionModificationDateFrom=01.01.2020&dateFormat=MM.dd.yyyy

Response format: JSON

Example response:

Code Block

{
	"total": 2,
	"maxResults": 100,
	"startAt": 0,
	"content": [
		{
			"lastPermissionModificationDate": 1727280841377,
			"lastPermissionModificationDateString": "2024-09-25 18:14:01",
			"name": "Welcome to Confluence",
			"id": 163841,
			"type": "page",
			"status": "current"
		},
		{
			"lastPermissionModificationDate": 1727280848170,
			"lastPermissionModificationDateString": "2024-09-25 18:14:08",
			"name": "Learn the wonders of autoconvert (step 7 of 9)",
			"id": 163860,
			"type": "page",
			"status": "current"
		}
	]
}

...

Changes

Info

Available since v. 2.17.0

New REST APIs:

Available since v. 2.31.0

New REST APIs:

Move/reorder page

Available since v. 3.12.*

New REST APIs:

Available since v. 3.16.*

Below REST APIs are now available to space administrators:

Available since v. 4.21.*

New REST APIAPsI:

Added support for blog posts in REST APIs:

Versions Compared

Old Version 7

New Version Current

Key

Get content post information

Replacing the text on the content (replace all)

Replacing the text on all contents in the space (replace all)

Check process status

Add text to the top of the content (prepend)

Add text to the end of the content (append)

Move/reorder page

Change the creator of all contents in the space created by the user

Change the creator of all content by id’s

Changes

Get the contents of a space for which the permission modification date changed on a specific date

Changes

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Get content post information

Replacing the text on the content (replace all)

Replacing the text on all contents in the space (replace all)

Check process status

Add text to the top of the content (prepend)

Add text to the end of the content (append)

Move/reorder page

Change the creator of all contents in the space created by the user

Change the creator of all content by id’s

Changes

Get the contents of a space for which the permission modification date changed on a specific date

Changes