The Confluence Cloud REST API

Content versions

Get content versions

GET /wiki/rest/api/content/{id}/version

Returns the versions for a piece of content in descending order.

Permissions required: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:confluence-content.summary

Granular:read:content-details:confluence

Request

Path parameters

id Required

string

The ID of the content to be queried for its versions.

Query parameters

start

integer

The starting index of the returned versions.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of versions to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

expand

Array<string>

A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded.

collaborators returns the users that collaborated on the version.
content returns the content for the version.

Style: form

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/version`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

403

Returned if the requested versions are returned.

Content type	Value
application/json	VersionArray

Restore content version

POST /wiki/rest/api/content/{id}/version

Restores a historical version to be the latest version. That is, a new version is created with the content of the historical version.

Permissions required: Permission to update the content.

Connect app scope required: WRITE

OAuth 2.0 scopes required:

ClassicRECOMMENDED:write:confluence-content

Granular:read:content-details:confluence, write:content:confluence

Request

Path parameters

id Required

string

The ID of the content for which the history will be restored.

Query parameters

expand

Array<string>

A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded.

collaborators returns the users that collaborated on the version.
content returns the content for the version.

Style: form

Body parameters

operationKey Required

string

Set to 'restore'.

Valid values: restore

params Required

object

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "operationKey": "restore",
  "params": {
    "versionNumber": 34,
    "message": "<string>",
    "restoreTitle": true
  }
}`;

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/version`, {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

400

403

Returned if the version is restored.

Content type	Value	Restrictions
application/json	Version	Nullable: `true`

Get content version

GET /wiki/rest/api/content/{id}/version/{versionNumber}

Returns a version for a piece of content.

Permissions required: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.

Connect app scope required: READ

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:confluence-content.summary

Granular:read:content-details:confluence

Request

Path parameters

id Required

string

The ID of the content to be queried for its version.

versionNumber Required

integer

The number of the version to be retrieved.

Format: int32

Query parameters

expand

Array<string>

A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded.

collaborators returns the users that collaborated on the version.
content returns the content for the version.

Style: form

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/version/{versionNumber}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

403

404

Returned if the version is returned.

Content type	Value	Restrictions
application/json	Version	Nullable: `true`

Delete content version

DELETE /wiki/rest/api/content/{id}/version/{versionNumber}

Delete a historical version. This does not delete the changes made to the content in that version, rather the changes for the deleted version are rolled up into the next version. Note, you cannot delete the current version.

Permissions required: Permission to update the content.

Connect app scope required: DELETE

OAuth 2.0 scopes required:

ClassicRECOMMENDED:write:confluence-content

Granular:delete:content:confluence

Request

Path parameters

id Required

string

The ID of the content that the version will be deleted from.

versionNumber Required

integer

The number of the version to be deleted. The version number starts from 1 up to current version.

Format: int32

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/version/{versionNumber}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

204

400

403

Returned if the version is deleted.

A schema has not been defined for this response code.