Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

...

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
breakoutModewide
{
    "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
breakoutModewide
languageactionscript3
{
    "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

...

Code Block
breakoutModewide
{
    "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
breakoutModewide
languageactionscript3
{
    "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
colourGreen
titleGET

...

Code Block
breakoutModewide
languageactionscript3
{
    "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
breakoutModewide
languageactionscript3
{
    "status": "done"
}

...

Add text to the end of the content (append)

Available only for Confluence Administrators or Space Administrator

...

Code Block
breakoutModewide
languageactionscript3
{
    "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
breakoutModewide
languageactionscript3
{
    "message": "The source page cannot be the same as the target page."
}

...

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

Available only for Confluence Administrators

...

Code Block
breakoutModewide
languageactionscript3
{
    "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
breakoutModewide
languageactionscript3
{
    "total": 1,
    "contentsSkipped": [
        1111111,
        2222222
    ],
    "contentsChanged": [
        786506
    ],
    "message": "success"
}

...

Changes

Info

Available since v. 2.17.0

New REST APIs:

Available since v. 2.31.0

New REST APIs:

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 API: Get content information

Added support for blog posts in REST APIs: