Content Resource

Returns a paginated list of Content. Example request URI(s):

• http://example.com/confluence/rest/api/content?spaceKey=TST&title=Cheese&expand=space,body.view,version,container
• http://example.com/confluence/rest/api/content?type=blogpost&spaceKey=TST&title=Bacon&postingDay=2014-02-13&expand=space,body.view,version,container

Request

Responses

Creates a new piece of Content or publishes the draft if the content id is present. For the case publishing draft, a new piece of content will be created and all metadata from the draft will be transferred into the newly created content.

Request

new content to be created.

Responses

Returns a piece of Content. Example request URI(s):

• http://example.com/confluence/rest/api/content/1234?expand=space,body.view,version,container
• http://example.com/confluence/rest/api/content/1234?status=any

Request

Responses

Trashes or purges a piece of Content, based on its ContentType and ContentStatus.

There are three cases:

• If the content is trashable and its status is current, it will be trashed.

• If the content is trashable, its status is trashed and the status query parameter in the request is trashed, the content will be purged from the trash and deleted permanently.

• If the content is not trashable it will be deleted permanently without being trashed.

Request

Responses

Returns the history of a particular piece of content. Example request URI(s):

• http://example.com/confluence/rest/api/content/1234/history
• http://example.com/confluence/rest/api/content/1234/history?expand=previousVersion,nextVersion,lastUpdated
• http://example.com/confluence/rest/api/content/1234/history?cql=creator=currentUser()&cqlcontext={"spaceKey":"TST", "contentId":"55"}&expand=previousVersion,nextVersion,lastUpdated
• http://example.com/confluence/rest/api/content/1234/history?cql=creator=currentUser()&cqlcontext={"spaceKey":"TST", "contentId":"55"}&expand=previousVersion,nextVersion,lastUpdated&start=0&limit=10

Request

Responses

Returns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect applications that require the body of macro to perform their work.

The hash is generated by connect during render time of the local macro holder and is usually only relevant during the scope of one request. For optimisation purposes, this hash will usually live for multiple requests.

Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with macroIds. This resource is currently only called from connect addons which will eventually all use the getContentById resource.

To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored macroId. This will allow add ons to work during the migration period.

Request

Responses

Returns the body of a macro (in storage format) with the given id. This resource is primarily used by connect applications that require the body of macro to perform their work.

When content is created, if no macroId is specified, then Confluence will generate a random id. The id is persisted as the content is saved and only modified by Confluence if there are conflicting IDs.

To preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macroId is found. This check will become redundant as pages get macroId's generated for them and transparently propagate out to all instances.

Request

Responses

Returns a paginated list of Content. Example request URI(s):

• http://example.com/confluence/rest/api/content/scan?spaceKey=TST&limit=100&expand=space,body.view,version,container
• http://example.com/confluence/rest/api/content/scan?limit=100&expand=space,body.view,version,container

Request

Responses

Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL

Example request URI(s):

• http://localhost:8080/confluence/rest/api/content/search?cql=creator=currentUser()&cqlcontext={"spaceKey":"TST", "contentId":"55"}
• http://localhost:8080/confluence/rest/api/content/search?cql=space=DEV AND label=docs&expand=space,metadata.labels&limit=10

Request

Responses

Updates a piece of Content, including changes to content status.

To update a piece of content you must increment the version.number, supplying the number of the version you are creating. The title property can be updated on all content, body can be updated on all content that has a body (not attachments). For instance to update the content of a blogpost that currently has version 1:

PUT /rest/api/content/456

1
2
3
4
5
6
7
8
9
10
11
12
13
{
   "version":{
       "number": 2
   },
   "title":"My new title",
   "type":"page",
   "body":{
        "storage":{
           "value":"<p>New page data.</p>",
           "representation":"storage"
      }
   }
}

To update a page and change its parent page, supply the ancestors property with the request with the parent as the first ancestor i.e. to move a page to be a child of page with ID 789:

PUT /rest/api/content/456

1
2
3
4
5
6
7
8
9
10
11
12
13
{
   "version":{
       "number": 2
   },
   "ancestors": [{"id":789}],
   "type":"page",
   "body":{
        "storage":{
           "value":"<p>New page data.</p>",
           "representation":"storage"
      }
   }
}

Changing status

To restore a piece of content that has the status of trashed the content must have it's version incremented, and status set to current. No other field modifications will be performed when restoring a piece of content from the trash.

Request example to restore from trash: {"id": "557059","status": "current","version": {"number": 2}}

If the content you're updating has a draft, specifying status=draft will delete that draft and the body of the content will be replaced with the body specified in the request.

Request example to delete a draft:

PUT: http://localhost:9096/confluence/rest/api/content/2149384202?status=draft

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
   "id":"2149384202",
   "status":"current",
   "version":{
      "number":4
   },
   "space":{
      "key":"TST"
   },
   "type":"page",
   "title":"page title",
   "body":{
      "storage":{
         "value":"<p>New page data.</p>",
         "representation":"storage"
      }
   }
}

Changing page position

To set page position, supply the position property in the request body with a positive integer. Content with unset positions will have a position value of -1. To unset a content position, supply position property with -1.

Request example to set page position to 1

PUT /rest/api/content/2149384202

1
2
3
4
5
6
7
8
9
{
   "id":"2149384202",
   "version":{
      "number":2
   },
   "type":"page",
   "title":"page title",
   "position":1
}

Request example to unset page position

PUT /rest/api/content/2149384202

1
2
3
4
5
6
7
8
{
   "id":"2149384202",
   "version":{
      "number":2
   },
   "type":"page",
   "position":-1
}

Request

new content to be created.

Responses