Confluence Cloud REST API v1
The legacy Confluence Cloud REST surface under /wiki/rest/api. 130 operations, still the only place several capabilities are published — CQL search, audit records, groups and users, content restrictions, templates and blueprints, themes and look-and-feel, relations, watchers, long-running tasks and attachment upload.
Confluence Cloud REST API v1 is one of 4 APIs that Atlassian Confluence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Search, Content, Users, Groups, and Audit. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a getting-started guide.
This API exposes
130 operations
across 89 paths,
organized into 28 resource areas,
and defines 168 schemas.
It is described by OpenAPI 3.0.1, at version 1.0.0.
Requests are made against a single base URL, //your-domain.atlassian.net.
The identity and technical contract details declared by the specification.
AccountId
object
1 property
1 required
AccountIdEmailRecord
object
2 properties
2 required
AccountIdEmailRecordArray
array
AffectedObject
object
2 properties
2 required
AsyncId
object
1 property
1 required
AttachmentUpdate
object
6 properties
3 required
AuditRecord
object
11 properties
10 required
AuditRecordArray
object
5 properties
5 required
AuditRecordCreate
object
10 properties
1 required
AvailableContentStates
object
2 properties
2 required
BlueprintTemplate
object
12 properties
8 required
BlueprintTemplateArray
object
5 properties
5 required
ButtonLookAndFeel
object
2 properties
2 required
Breadcrumb
object
3 properties
3 required
ChangedValue
object
5 properties
3 required
ConnectModule
object
A [Connect module](https://developer.atlassian.com/cloud/confluence/modules/admin-page/) in the same format as in the [app descriptor](https://developer.atlass…
ConnectModules
object
1 property
1 required
Container
object
Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
ContainerLookAndFeel
object
12 properties
6 required
ContainerSummary
object
2 properties
2 required
AttachmentPropertiesUpdateBody
object
8 properties
3 required
Content
object
Base object for all content types.
20 properties
2 required
ContentArray
object
5 properties
3 required
ContentBlogpost
Representation of a blogpost (content)
ContentBlueprintDraft
object
6 properties
3 required
AsyncContentBody
object
10 properties
AsyncContentBodyArray
array
ContentBody
object
7 properties
2 required
ContentBodyCreate
object
This object is used when creating or updating content.
2 properties
2 required
ContentChildren
object
9 properties
ContentBodyCreateStorage
object
This object is used when creating or updating content.
2 properties
2 required
ContentChildType
object
Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.
4 properties
ContentCreate
object
8 properties
1 required
ContentHistory
object
11 properties
1 required
ContentLookAndFeel
object
4 properties
ContentMetadata
object
Metadata object for page, blogpost, comment content
4 properties
ContentProperty
object
6 properties
4 required
ContentPropertyArray
object
5 properties
5 required
ContentPropertyCreate
object
2 properties
2 required
ContentPropertyCreateNoKey
object
1 property
1 required
ContentPropertyUpdate
object
2 properties
2 required
ContentRestriction
object
5 properties
3 required
ContentRestrictionArray
object
6 properties
6 required
ContentRestrictionUpdate
object
3 properties
2 required
ContentRestrictionAddOrUpdateArray
AddContentRestriction
object
2 properties
2 required
AddContentRestrictionUpdateArray
array
ContentPageResponse
object
4 properties
4 required
ContentState
object
3 properties
3 required
ContentStateRestInput
object
3 properties
ContentStateResponse
object
2 properties
ContentStateSettings
object
4 properties
3 required
ContentTemplate
object
12 properties
6 required
ContentTemplateArray
object
5 properties
5 required
ContentTemplateCreate
object
This object is used to create content templates.
6 properties
3 required
ContentTemplateBody
object
The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage. Note, edito…
9 properties
ContentTemplateBodyCreate
object
The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage. Note, edito…
9 properties
ContentTemplateUpdate
object
This object is used to update content templates.
7 properties
4 required
ContentUpdate
object
6 properties
2 required
ContentBodyConversionInput
object
7 properties
2 required
BulkContentBodyConversionInput
object
1 property
CopyPageHierarchyRequest
object
8 properties
1 required
CopyPageHierarchyTitleOptions
object
Required for copying page in the same space.
3 properties
CopyPageRequest
object
8 properties
1 required
CopyPageRequestDestination
object
Defines where the page will be copied to, and can be one of the following types. - parentpage: page will be copied as a child of the specified parent page - pa…
2 properties
2 required
CQLPersonalDataConvertedQueries
object
The converted CQL queries.
1 property
1 required
CQLPersonalDataMigrationRequest
object
The CQL queries to be converted.
1 property
1 required
DynamicModulesErrorMessage
object
1 property
1 required
EmbeddedContent
object
3 properties
GenericAccountId
string
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
GenericUserName
string
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
GenericUserKey
string
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
GlobalSpaceIdentifier
object
1 property
1 required
Group
object
6 properties
3 required
GroupCreate
object
2 properties
1 required
GroupArray
object
4 properties
4 required
GroupArrayWithLinks
object
Same as GroupArray but with links property.
6 properties
5 required
GroupName
object
1 property
1 required
HeaderLookAndFeel
object
5 properties
5 required
HorizontalHeaderLookAndFeel
object
5 properties
2 required
Icon
object
This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
4 properties
4 required
Label
object
4 properties
4 required
LabelArray
object
5 properties
2 required
LabeledContent
object
3 properties
3 required
LabeledContentType
string
LabeledContentPageResponse
object
4 properties
2 required
LabelDetails
object
2 properties
1 required
LabelCreate
object
2 properties
2 required
LongTask
object
3 properties
2 required
LookAndFeel
object
8 properties
6 required
LookAndFeelWithLinks
Look and feel settings returned after an update.
LookAndFeelSelection
object
Look and feel selection
2 properties
2 required
LookAndFeelSettings
object
4 properties
3 required
LongTaskStatus
object
Current status of a long running task Status keys: - ERRORUNKNOWN - Generic error - ERRORLOCKFAILED - Could not get the lock on destination space - ERRORRELINK…
11 properties
7 required
LongTaskStatusArray
object
5 properties
5 required
LongTaskStatusWithLinks
object
Same as LongTaskStatus but with links property. Status keys: - ERRORUNKNOWN - Generic error - ERRORLOCKFAILED - Could not get the lock on destination space - E…
12 properties
8 required
MacroInstance
object
4 properties
MenusLookAndFeel
object
2 properties
2 required
Message
object
2 properties
1 required
BulkUserLookup
object
17 properties
9 required
BulkUserLookupArray
object
5 properties
5 required
NavigationLookAndFeel
object
3 properties
2 required
TopNavigationLookAndFeel
object
3 properties
1 required
OperationCheckResult
object
An operation and the target entity that it applies to, e.g. create page.
2 properties
2 required
PropertyValue
The value of the property. This can be empty or a complex object. 64KB Size Limit For example, "value": { "example1": "value", "example2": true, "example3": 12…
Relation
object
6 properties
2 required
RelationArray
object
5 properties
5 required
RelationData
object
3 properties
RetentionPeriod
object
2 properties
2 required
ScreenLookAndFeel
object
15 properties
1 required
SearchFieldLookAndFeel
object
2 properties
2 required
SearchPageResponseSearchResult
object
9 properties
8 required
SearchResult
object
14 properties
7 required
Space
object
18 properties
6 required
SpaceArray
object
5 properties
5 required
SpaceCreate
object
This is the request object used when creating a new space.
5 properties
1 required
SpaceUpdate
object
The properties of a space that can be updated.
5 properties
SpaceDescription
object
3 properties
3 required
SpaceDescriptionCreate
object
The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.
1 property
1 required
SpacePermission
object
This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following c…
5 properties
3 required
SpacePermissionCreate
object
This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following c…
4 properties
3 required
SpaceProperty
object
7 properties
4 required
SpacePropertyArray
object
5 properties
5 required
SpacePropertyCreate
object
3 properties
2 required
SpacePropertyCreateNoKey
object
1 property
1 required
SpacePropertyUpdate
object
4 properties
2 required
SpaceSettings
object
5 properties
2 required
SpaceSettingsUpdate
object
2 properties
SpaceWatch
object
5 properties
2 required
SpaceWatchArray
object
5 properties
4 required
SuperBatchWebResources
object
4 properties
SystemInfoEntity
object
9 properties
2 required
TaskStatusUpdate
object
1 property
1 required
Task
object
15 properties
6 required
TaskPageResponse
object
4 properties
4 required
Theme
object
5 properties
1 required
ThemeNoLinks
object
Theme object without links. Used in ThemeArray.
4 properties
1 required
ThemeArray
object
5 properties
5 required
ThemeUpdate
object
1 property
1 required
User
object
18 properties
1 required
UserAnonymous
object
6 properties
4 required
UserArray
object
6 properties
1 required
UserDetails
object
2 properties
UserProperty
object
6 properties
5 required
UserPropertyKeyArray
object
5 properties
1 required
UserPropertyCreate
object
1 property
1 required
UserPropertyUpdate
object
1 property
1 required
UsersUserKeys
object
3 properties
1 required
UserWatch
object
1 property
1 required
Version
object
14 properties
3 required
VersionArray
object
5 properties
5 required
VersionRestore
object
2 properties
2 required
Watch
object
3 properties
3 required
WatchArray
object
5 properties
5 required
WatchUser
object
This essentially the same as the User object, but no links property and no expandable property (therefore, different required fields).
16 properties
12 required
WebResourceDependencies
object
6 properties
PermissionSubject
object
The user or group that the permission applies to.
2 properties
2 required
PermissionSubjectWithGroupId
object
The user or group that the permission applies to.
2 properties
2 required
SpacePermissionV2
object
This object represents a single space permission. Permissions consist of at least one operation object with an accompanying subjects object. The following comb…
4 properties
3 required
SpacePermissionRequest
object
This object represents the request for the single space permission. Permissions consist of one operation object with an accompanying subjects object. The follo…
3 properties
2 required
SpacePermissionCustomContent
object
This object represents a list of space permissions for custom content type for an individual user. Permissions consist of a subjects object and a list with at…
2 properties
2 required
ContentPermissionRequest
object
This object represents the request for the content permission check API.
2 properties
2 required
PermissionCheckResponse
object
This object represents the response for the content permission check API. If the user or group does not have permissions, the following errors may be returned:…
3 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Atlassian Confluence publishes across the network.