Confluence REST API documentation

This document describes the REST API and resources provided by Confluence wiki. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.

Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is XML. If you wish, you can request JSON instead of XML. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

Structure of the REST URIs

URIs for a Confluence REST API resource have the following structure:

With context: http://host:port/context/rest/api-name/api-version/resource-name

Or without context: http://host:port/rest/api-name/api-version/resource-name

Currently, the only api-name available is 'prototype'. This is an API that allows basic interactions with a Confluence installation and retrieves information about space and content details.

Example with context: http://myhost.com:8080/confluence/rest/prototype/1/space/ds

Example without context: http://confluence.myhost.com:8095/rest/prototype/1/space/ds

How to use expansion in the REST APIs

In order to be minimise network traffic from the client perspective, our API uses a technique called expansion.

You can use the 'expand' query parameter to specify a comma-separated list of entities that you want expanded, identifying each entity by a given identifier. For example, the value "space,attachments" requests the expansion of entities for which the expand identifier is "space" and "attachments".

To discover the identifiers for each entity, look at the 'expand' attribute in the parent entity. In the XML example below, the page entity declares space, children, comments and attachments as being expandable.

Note: The 'expand' attribute should not be confused with the 'expand' query parameter which specifies which entities you want expanded.

You can use the dot notation to specify expansion of entities within another entity. For example "children.children" would expand the children and the children's children (because its expand identifier is children) and the child entities within the plugin.

If not otherwise indicated, all methods return both XML and JSON. Below are examples of the XML and JSON representations.

XML representation:
[expand]
<content type="page" expand="space,children,comments,attachments" id="6132456">
<link rel="alternate" type="text/html" href="http://localhost:8080/confluence/display/TST/Home"/>
<link rel="alternate" type="applicaton/pdf" href="http://localhost:8080/confluence/spaces/flyingpdf/pdfpageexport.action?pageId=6132456"/>
<link rel="self" href="http://localhost:8080/confluence/rest/prototype/1/content/6132456"/>
<title>Home</title>
<wikiLink>[TST:Home]</wikiLink>
<lastModifiedDate date="2010-03-16T11:50:31+1100" friendly="about 2 hours ago"/>
<createdDate date="2010-03-16T11:50:31+1100" friendly="about 2 hours ago"/>
<space type="space" title="Test Space" name="Test Space" key="TST">
<link rel="self" href="http://localhost:8080/confluence/rest/prototype/1/space/TST"/>
</space>
<children size="0"/>
<comments total="0"/>
<body>
This is the home of the Test Space space. To help you on your way, we've inserted some of our favourite macros on this home page. As you start creating pages, blogging and commenting you'll see the macros below fill up with all the activity in your space.
</body>
<attachments size="0"/>
</content>
The same content in JSON:
[expand]
{id:"6132456",
expand:"space,children,comments,attachments",
type:"page",
link:[{href:"http://localhost:8080/confluence/display/TST/Home",type:"text/html",rel:"alternate"},
  {href:"http://localhost:8080/confluence/spaces/flyingpdf/pdfpageexport.action?pageId=6132456",type:"applicaton/pdf",rel:"alternate"},
  {href:"http://localhost:8080/confluence/rest/prototype/1/content/6132456",rel:"self"}],
title:"Home",
wikiLink:"[TST:Home]",
lastModifiedDate:{friendly:"about 2 hours ago",date:"2010-03-16T11:50:31+1100"},
createdDate:{friendly:"about 2 hours ago",date:"2010-03-16T11:50:31+1100"},
space:{key:"TST",name:"Test Space",title:"Test Space",link:[{href:"http://localhost:8080/confluence/rest/prototype/1/space/TST",rel:"self"}],type:"space"},
children:{size:0},
comments:{total:0},
body:"This is the home of the Test Space space.\n\nTo help you on your way, we've inserted some of our favourite macros on this home page. As you start creating pages, blogging and commenting you'll see the macros below fill up with all the activity in your space.",
attachments:{size:0}}

This document the current REST API provided by Confluence.

Resources

/session

Methods

GET

Returns the UserSessionEntity for the user making the request. Example URL: http://host/confluence/rest/prototype/1/session

available response representations:

  • 200 (userSessionEntity) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <session>
        <history size="2">
            <content type="page">
                <link rel="self" href="http://localhost"/>
                <link rel="alternate" href="http://localhost"/>
                <link rel="alternate" type="application/pdf" href="http://localhost"/>
                <title>Home</title>
                <wikiLink>[ds:Home]</wikiLink>
                <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                    <link rel="self" href="http://localhost"/>
                </space>
            </content>
            <content type="page">
                <link rel="self" href="http://localhost"/>
                <link rel="alternate" href="http://localhost"/>
                <link rel="alternate" type="application/pdf" href="http://localhost"/>
                <title>Home</title>
                <wikiLink>[ds:Home]</wikiLink>
                <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                    <link rel="self" href="http://localhost"/>
                </space>
            </content>
        </history>
    </session>
    

    A UserSessionEntity. By default the history is not expanded.

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="userSessionEntity">
        <xs:sequence>
          <xs:element name="history" type="contentEntityList" minOccurs="0"/>
        </xs:sequence>
        <xs:attribute name="expand" type="xs:string"/>
      </xs:complexType>

/session/history?start-index&max-results

Methods

GET

Returns the UserHistoryList for the user making the request. Example URL: http://host/confluence/rest/prototype/1/session/history

request query parameters
parameter value description

start-index

string

The first (inclusive) index to return. Can be any integer zero or greater.

max-results

string

The number of results to return. Can be any positive integer.

available response representations:

  • 200 [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <history>
        <content type="page">
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <link rel="alternate" type="application/pdf" href="http://localhost"/>
            <title>Home</title>
            <wikiLink>[ds:Home]</wikiLink>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                <link rel="self" href="http://localhost"/>
            </space>
        </content>
        <content type="page">
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <link rel="alternate" type="application/pdf" href="http://localhost"/>
            <title>Home</title>
            <wikiLink>[ds:Home]</wikiLink>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                <link rel="self" href="http://localhost"/>
            </space>
        </content>
    </history>
    

    A list of the pages visited by this user. Note that this list does not include calls made via the REST API (such as the content service).

/breadcrumb?id&type

REST resource for getting displayable breadcrumbs for confluence content

Methods

GET

Gets the breadcrumbs to display for the given content id and type.

request query parameters
parameter value description

id

long

Default: -1

type

string

available response representations:

  • 404 [expand]

    Returns HTTP 404 (not found) if content for the given id is not found or the user is not permitted to view it.

  • 200 [expand]

    Breadcrumbs for the content to display

/user

Methods

/user/non-system/{username}

resource-wide template parameters
parameter value description

username

string

Methods

GET

available response representations:

/user/system/anonymous

Methods

GET

available response representations:

/user/current

Methods

GET

available response representations:

/

Methods

GET

Returns an empty page. Note that this method will not even return a valid XML document nor valid JSON.

available response representations:

/attachment

Methods

GET

This method will always return HTTP 404 (not found) as it can not find attachments without an ID.

available response representations:

  • 404 [expand]

    This method will always return HTTP 404 (not found) as it can not find attachments without an ID.

/attachment/{id}

resource-wide template parameters
parameter value description

id

long

Methods

GET

Returns a full representation of the attachment for the given ID. The ID is that of an attachment and not the page it is attached to.

available response representations:

  • 404 [expand]

    Returned if the requested attachment is not found, or the user does not have permission to see it

  • 200 (attachmentEntity) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <attachment niceType="Image" version="1" comment="Shot of the Harbour Bridge from below" niceFileSize="147 kB" fileSize="150652" contentType="image/jpeg" fileName="harbour bridge3.jpg" type="attachment" id="6488237l">
        <ownerId>6389783</ownerId>
        <link rel="self" href="http://localhost"/>
        <link rel="alternate" href="http://localhost"/>
        <title>harbour bridge3.jpg</title>
        <thumbnailWidth>0</thumbnailWidth>
        <thumbnailHeight>0</thumbnailHeight>
        <wikiLink>[ds:Josh^harbour bridge3.jpg]</wikiLink>
        <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
            <link rel="self" href="http://localhost"/>
        </space>
        <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
    </attachment>
    

    Full representation of the attachment with links to download the binary data.

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="attachmentEntity">
        <xs:complexContent>
          <xs:extension base="searchResultEntity">
            <xs:sequence>
              <xs:element name="ownerId" type="xs:string" minOccurs="0"/>
              <xs:element name="parentTitle" type="xs:string" minOccurs="0"/>
              <xs:element ref="link" maxOccurs="unbounded" minOccurs="0"/>
              <xs:element name="title" type="xs:string" minOccurs="0"/>
              <xs:element name="thumbnailLink" type="link" minOccurs="0"/>
              <xs:element name="thumbnailWidth" type="xs:int"/>
              <xs:element name="thumbnailHeight" type="xs:int"/>
              <xs:element name="wikiLink" type="xs:string" minOccurs="0"/>
              <xs:element ref="space" minOccurs="0"/>
              <xs:element name="lastModifiedDate" type="dateEntity" minOccurs="0"/>
              <xs:element name="createdDate" type="dateEntity" minOccurs="0"/>
            </xs:sequence>
            <xs:attribute name="type" type="xs:string"/>
            <xs:attribute name="fileName" type="xs:string"/>
            <xs:attribute name="contentType" type="xs:string"/>
            <xs:attribute name="fileSize" type="xs:long" use="required"/>
            <xs:attribute name="niceFileSize" type="xs:string"/>
            <xs:attribute name="comment" type="xs:string"/>
            <xs:attribute name="version" type="xs:int" use="required"/>
            <xs:attribute name="niceType" type="xs:string"/>
            <xs:attribute name="iconClass" type="xs:string"/>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>

/buildInfo

Methods

GET

available response representations:

/content

Rest resource for accessing Confluence content. Currently supports only read access for pages, blogs and comments.

Methods

GET

Returns HTTP 404 (not found) as there is no content to return if no ID is passed.

available response representations:

  • 404 [expand]

    Always returned as no content can be retrieved without ID.

/content/{id}

resource-wide template parameters
parameter value description

id

long

Methods

GET

Returns the content for the given ID.

available response representations:

  • 404 [expand]

    Returned if the requested content is not found, or the user does not have permission to see it

  • 200 (contentEntity) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <content type="page">
        <link rel="self" href="http://localhost"/>
        <link rel="alternate" href="http://localhost"/>
        <link rel="alternate" type="application/pdf" href="http://localhost"/>
        <title>Home</title>
        <wikiLink>[ds:Home]</wikiLink>
        <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
            <link rel="self" href="http://localhost"/>
        </space>
        <body type="0">h1. Demo Area
    
    Confluence is Enterprise [wiki software|http://www.atlassian.com/software/confluence] which extends beyond average wikis. Confluence is available for both [download|http://www.atlassian.com/software/confluence/ConfluenceDownloadCenter.jspa] &amp;
     [hosted|http://www.atlassian.com/software/confluence/hosted.jsp] versions.
    
    
    To get an quick overview, we recommend browsing through the tours suggested above.
    </body>
    </content>
    

    Full representation of the content item.

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="contentEntity">
        <xs:complexContent>
          <xs:extension base="searchResultEntity">
            <xs:sequence>
              <xs:element ref="link" maxOccurs="unbounded" minOccurs="0"/>
              <xs:element name="title" type="xs:string" minOccurs="0"/>
              <xs:element name="parentId" type="xs:string" minOccurs="0"/>
              <xs:element name="wikiLink" type="xs:string" minOccurs="0"/>
              <xs:element name="lastModifiedDate" type="dateEntity" minOccurs="0"/>
              <xs:element name="createdDate" type="dateEntity" minOccurs="0"/>
              <xs:element ref="space" minOccurs="0"/>
              <xs:element name="children" type="contentEntityList" minOccurs="0"/>
              <xs:element ref="comments" minOccurs="0"/>
              <xs:element ref="body" minOccurs="0"/>
              <xs:element ref="attachments" minOccurs="0"/>
              <xs:element ref="labels" minOccurs="0"/>
              <xs:element name="creator" type="userEntity" minOccurs="0"/>
              <xs:element name="lastModifier" type="userEntity" minOccurs="0"/>
              <xs:element name="username" type="xs:string" minOccurs="0"/>
              <xs:element name="thumbnailLink" type="link" minOccurs="0"/>
            </xs:sequence>
            <xs:attribute name="expand" type="xs:string"/>
            <xs:attribute name="type" type="xs:string"/>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>

/content/{id}/attachments?start-index&max-results&mimeType&attachmentType&reverseOrder

resource-wide template parameters
parameter value description

id

long

ID of resource (such as a page or blog post)

Methods

GET

Returns the attachments for a given resource. The results are ordered by the creation date.

request query parameters
parameter value description

start-index

string

Index of first item (inclusive) to return.

max-results

string

Maximum number of items to return. Default is 50.

mimeType

string

Mime types to filter the attachments by, such as: image/jpeg

attachmentType

string

'Nice' type to filter the attachments by. Filtering is case insensititve. Can be one or more of: PDF, IMAGE, XML, HTML, TEXT, WORD, EXCEL, POWERPOINT, JAVA_SOURCE, JAVA_ARCHIVE, ZIP. You can specify multiple types like this: ?attachmentType=image&attachmentType=pdf

reverseOrder

boolean

Default: false

set to true to have the results returned in reverse chronological order.

available response representations:

  • 404 [expand]

    Returned if the requested content item is not found, or the user does not have permission to see it

  • 200 (attachmentEntity) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <attachments size="2">
        <attachment niceType="Image" version="1" comment="Shot of the Harbour Bridge from below" niceFileSize="147 kB" fileSize="150652" contentType="image/jpeg" fileName="harbour bridge3.jpg" type="attachment" id="6488237l">
            <ownerId>6389783</ownerId>
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <title>harbour bridge3.jpg</title>
            <thumbnailWidth>0</thumbnailWidth>
            <thumbnailHeight>0</thumbnailHeight>
            <wikiLink>[ds:Josh^harbour bridge3.jpg]</wikiLink>
            <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                <link rel="self" href="http://localhost"/>
            </space>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        </attachment>
        <attachment niceType="Image" version="1" comment="Shot of the Harbour Bridge from below" niceFileSize="147 kB" fileSize="150652" contentType="image/jpeg" fileName="harbour bridge3.jpg" type="attachment" id="6488237l">
            <ownerId>6389783</ownerId>
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <title>harbour bridge3.jpg</title>
            <thumbnailWidth>0</thumbnailWidth>
            <thumbnailHeight>0</thumbnailHeight>
            <wikiLink>[ds:Josh^harbour bridge3.jpg]</wikiLink>
            <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                <link rel="self" href="http://localhost"/>
            </space>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        </attachment>
    </attachments>
    

    Full representation of the attachments with links to download the binary data.

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="attachmentEntity">
        <xs:complexContent>
          <xs:extension base="searchResultEntity">
            <xs:sequence>
              <xs:element name="ownerId" type="xs:string" minOccurs="0"/>
              <xs:element name="parentTitle" type="xs:string" minOccurs="0"/>
              <xs:element ref="link" maxOccurs="unbounded" minOccurs="0"/>
              <xs:element name="title" type="xs:string" minOccurs="0"/>
              <xs:element name="thumbnailLink" type="link" minOccurs="0"/>
              <xs:element name="thumbnailWidth" type="xs:int"/>
              <xs:element name="thumbnailHeight" type="xs:int"/>
              <xs:element name="wikiLink" type="xs:string" minOccurs="0"/>
              <xs:element ref="space" minOccurs="0"/>
              <xs:element name="lastModifiedDate" type="dateEntity" minOccurs="0"/>
              <xs:element name="createdDate" type="dateEntity" minOccurs="0"/>
            </xs:sequence>
            <xs:attribute name="type" type="xs:string"/>
            <xs:attribute name="fileName" type="xs:string"/>
            <xs:attribute name="contentType" type="xs:string"/>
            <xs:attribute name="fileSize" type="xs:long" use="required"/>
            <xs:attribute name="niceFileSize" type="xs:string"/>
            <xs:attribute name="comment" type="xs:string"/>
            <xs:attribute name="version" type="xs:int" use="required"/>
            <xs:attribute name="niceType" type="xs:string"/>
            <xs:attribute name="iconClass" type="xs:string"/>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>

/space?type&start-index&max-results&spaceKey

Rest resource for accessing Confluence spaces. Currently supports only read access to spaces.

Methods

GET

Retrieves a list of spaces visible to the currently logged in user, alphabetically by space name. An optional parameter 'type' allows filtering on space type. The standard paging parameters 'start-index' and 'max-results' can be used to page through the list. A maximum of 50 (defined by {@link DefaultRestSpaceManager#DEFAULT_MAX_SIZE}) spaces will be listed.

request query parameters
parameter value description

type

string

Default: all

The space type parameter to filter the list by. Type can be one of: GLOBAL, PERSONAL, ALL

start-index

string

The first (inclusive) index to return. Can be any integer zero or greater.

max-results

string

The number of results to return. Can be any positive integer.

spaceKey

string

a list of space keys to view

available response representations:

  • 200 (spaceEntityList) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <spaces>
        <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds" id="1">
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <description>An example of a Confluence space with a tutorial and sample content.</description>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <wikiLink>[ds:]</wikiLink>
            <rootpages size="2"/>
            <userproperties/>
            <home type="page">
                <link rel="self" href="http://localhost"/>
                <link rel="alternate" href="http://localhost"/>
                <link rel="alternate" type="application/pdf" href="http://localhost"/>
                <title>Home</title>
                <wikiLink>[ds:Home]</wikiLink>
                <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                    <link rel="self" href="http://localhost"/>
                </space>
            </home>
        </space>
        <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds" id="1">
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <description>An example of a Confluence space with a tutorial and sample content.</description>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <wikiLink>[ds:]</wikiLink>
            <rootpages size="2"/>
            <userproperties/>
            <home type="page">
                <link rel="self" href="http://localhost"/>
                <link rel="alternate" href="http://localhost"/>
                <link rel="alternate" type="application/pdf" href="http://localhost"/>
                <title>Home</title>
                <wikiLink>[ds:Home]</wikiLink>
                <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
                <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                    <link rel="self" href="http://localhost"/>
                </space>
            </home>
        </space>
    </spaces>
    

    A list of spaces

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="spaceEntityList">
        <xs:sequence>
          <xs:element ref="space" maxOccurs="unbounded" minOccurs="0"/>
        </xs:sequence>
        <xs:attribute name="expand" type="xs:string"/>
      </xs:complexType>

/space/{key}

resource-wide template parameters
parameter value description

key

string

Methods

GET

Returns information about a space identified by the key passed. ReturnsReturns http HTTP 404 (not found) if the space is not found or the user requesting it does not have the correct permissions.

available response representations:

  • 404 [expand]

    Response when the requested space does not exist or the user requesting it does not have sufficent rights to see it.

  • 200 (spaceEntity) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds" id="1">
        <link rel="self" href="http://localhost"/>
        <link rel="alternate" href="http://localhost"/>
        <description>An example of a Confluence space with a tutorial and sample content.</description>
        <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
        <wikiLink>[ds:]</wikiLink>
        <rootpages size="2"/>
        <userproperties/>
        <home type="page">
            <link rel="self" href="http://localhost"/>
            <link rel="alternate" href="http://localhost"/>
            <link rel="alternate" type="application/pdf" href="http://localhost"/>
            <title>Home</title>
            <wikiLink>[ds:Home]</wikiLink>
            <lastModifiedDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <createdDate date="2009-11-24T13:09:46+1100" friendly="Nov 24"/>
            <space type="space" title="Demonstration Space" name="Demonstration Space" key="ds">
                <link rel="self" href="http://localhost"/>
            </space>
        </home>
    </space>
    

    A detailed description of a space.

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="spaceEntity">
        <xs:complexContent>
          <xs:extension base="searchResultEntity">
            <xs:sequence>
              <xs:element ref="link" maxOccurs="unbounded" minOccurs="0"/>
              <xs:element name="description" type="xs:string" minOccurs="0"/>
              <xs:element name="lastModifiedDate" type="dateEntity" minOccurs="0"/>
              <xs:element name="createdDate" type="dateEntity" minOccurs="0"/>
              <xs:element name="wikiLink" type="xs:string" minOccurs="0"/>
              <xs:element name="rootpages" type="contentEntityList" minOccurs="0"/>
              <xs:element ref="userproperties" minOccurs="0"/>
              <xs:element name="home" type="contentEntity" minOccurs="0"/>
            </xs:sequence>
            <xs:attribute name="expand" type="xs:string"/>
            <xs:attribute name="key" type="xs:string"/>
            <xs:attribute name="name" type="xs:string"/>
            <xs:attribute name="title" type="xs:string"/>
            <xs:attribute name="type" type="xs:string"/>
          </xs:extension>
        </xs:complexContent>
      </xs:complexType>

/search?query&type&search&startIndex&pageSize&max-results&spaceKey&attachmentType&label&groupResults&searchParentName&preferredSpaceKey

A service providing search results using the Confluence search with various parameters.

Methods

GET

Search Confluence using the given parameters.

request query parameters
parameter value description

query

string

type

string

search

string

Default: site

startIndex

int

Default: 0

pageSize

int

max-results

int

spaceKey

string

attachmentType

string

label

string

groupResults

boolean

Default: true

searchParentName

boolean

Default: false

preferredSpaceKey

string

available response representations:

  • 200 (searchResultEntityList) [expand]

    Results matching criteria. Depending on parameters the results are either in groups (quick search) or results (full search) fields.

    XML Schema

    Source: schema1.xsd

    <xs:complexType name="searchResultEntityList">
        <xs:sequence>
          <xs:element name="result" type="searchResultEntity" maxOccurs="unbounded" minOccurs="0"/>
          <xs:element ref="group" maxOccurs="unbounded" minOccurs="0"/>
          <xs:element name="totalSize" type="xs:int"/>
        </xs:sequence>
      </xs:complexType>

/search/site?query&type&spaceKey&attachmentType&label&startIndex&pageSize

Methods

GET

Site wide Confluence search.

request query parameters
parameter value description

query

string

query string

type

string

content types to search for

spaceKey

string

keys of spaces to search in, if not specified it searches in all spaces

attachmentType

string

attachment types to search in, if not specified it searches all attachments

label

string

start index of search results

startIndex

int

Default: 0

max page size of search results

pageSize

int

Filters the results for content with the specified labels, if not specified all results are returned

available response representations:

/search/name?query&type&spaceKey&attachmentType&label&groupResults&searchParentName&preferredSpaceKey&startIndex&pageSize

Methods

GET

Search is performed on the name of content only e.g. title of page, name of attachment

request query parameters
parameter value description

query

string

type

string

spaceKey

string

attachmentType

string

label

string

groupResults

boolean

Default: true

searchParentName

boolean

Default: false

preferredSpaceKey

string

startIndex

int

Default: 0

pageSize

int

available response representations:

/search/user?query&max-results

Methods

GET

User specific search. Searches on username and full name.

request query parameters
parameter value description

query

string

query string

max-results

int

maximum number of search results

available response representations:

/i18n?pluginKeys

Rest resource for accessing translations in Confluence.

Methods

GET

Returns the text for the given plugin keys.

request query parameters
parameter value description

pluginKeys

string

available response representations:

  • 404 [expand]

    This method will return HTTP 404 (not found) if there are no plugin keys specified

  • 200 [expand]

    A message bundle with all the translated content for the given set of plugin keys.

/i18n/{key}

resource-wide template parameters
parameter value description

key

string

The plugin key as it is defined in the atlassian-plugin.xml.

Methods

GET

Returns the text for the given plugin key. If the specified plugin key does not exist, or the caller does not have permission to access the plugin texts, the response is HTTP 404 (not found). Note that only JSON is returned. An example URL including a plugin key would look like this: http://host/confluence/rest/prototype/1/i18n/com.atlassian.confluence.tinymceplugin

available response representations:

  • 404 [expand]

    Response when the requested resource is not found.

  • 200 [expand]

    A message bundle with all the translated content for the given plugin key.