How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian Content States API

The Content States API from Atlassian — 8 operation(s) for content states.

Atlassian Content States API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Content States. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 11 operations across 8 paths, and defines 55 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, //your-domain.atlassian.net.

11 operations 8 paths 55 schemas 1 DELETE7 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
//your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Content States API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 73 scopes.

  • basicAuth — You can access this resource via basic auth.
  • oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 7 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Content States 11
GET
/wiki/rest/api/content/{id}/state
Atlassian Get Content State
atlassianGetcontentstate 2 params → 200401403404
PUT
/wiki/rest/api/content/{id}/state
Atlassian Set The Content State Of A Content And Publishes A New Version Of The Content
atlassianSetcontentstate 2 params body → 200400401403404
DELETE
/wiki/rest/api/content/{id}/state
Atlassian Removes The Content State Of A Content And Publishes A New Version
atlassianRemovecontentstate 2 params → 200401403404
GET
/wiki/rest/api/content/{id}/state/available
Atlassian Gets Available Content States For Content
atlassianGetavailablecontentstates 1 param → 200400401403404
PUT
/wiki/rest/api/content-statesdeprecated
Atlassian Bulk Set Content State Of Many Contents
atlassianBulksetcontentstates 1 param body → 200400404
GET
/wiki/rest/api/content-states
Atlassian Get Custom Content States
atlassianGetcustomcontentstates → 200401
POST
/wiki/rest/api/content-states/delete
Atlassian Bulk Remove Content States From Content
atlassianBulkremovecontentstates 1 param body → 200400401403404
GET
/wiki/rest/api/content-states/task/{taskId}
Atlassian Get Update On Long Running Task For Setting Of Content State
atlassianGettaskupdate 1 param → 200403404
GET
/wiki/rest/api/space/{spaceKey}/state
Atlassian Get Space Suggested Content States
atlassianGetspacecontentstates 1 param → 200401403404
GET
/wiki/rest/api/space/{spaceKey}/state/settings
Atlassian Get Content State Settings For Space
atlassianGetcontentstatesettings 1 param → 200401403404
GET
/wiki/rest/api/space/{spaceKey}/state/content
Atlassian Get Content In Space With Given Content State
atlassianGetcontentswithstate 5 params → 200400401403404

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are Content (20 properties), Space (17 properties), User (17 properties), ScreenLookAndFeel (15 properties). Each schema is shown below with its type and property counts.

ContentLookAndFeel
object
4 properties
GenericAccountId
stringnull
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
ContentBody
object
7 properties 2 required
HeaderLookAndFeel
object
5 properties 5 required
ContentArray
object
5 properties 3 required
SearchFieldLookAndFeel
objectnull
2 properties 2 required
ButtonLookAndFeel
objectnull
2 properties 2 required
GenericUserKey
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
ScreenLookAndFeel
object
15 properties 1 required
HorizontalHeaderLookAndFeel
object
5 properties 2 required
Embeddable
object
Icon
objectnull
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
SpaceSettings
objectnull
4 properties 2 required
ContentRestriction
object
5 properties 3 required
ContentChildren
object
5 properties
Group
object
4 properties 3 required
TopNavigationLookAndFeel
object
3 properties 1 required
ContentStateSettings
object
4 properties 3 required
SuperBatchWebResources
object
4 properties
BulkContentStateSetInput
object
2 properties 2 required
UsersUserKeys
objectnull
3 properties 1 required
GenericUserName
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
Label
object
4 properties 4 required
Content
objectnull
Base object for all content types.
20 properties 2 required
ContentStateRestInput
object
3 properties
Space
objectnull
17 properties 6 required
Theme
object
5 properties 1 required
Container
objectnull
Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
LookAndFeel
object
8 properties 6 required
EmbeddedContent
object
3 properties
ContentState
object
3 properties 3 required
ContentId
string
GroupArray
object
4 properties 4 required
OperationCheckResult
object
An operation and the target entity that it applies to, e.g. create page.
2 properties 2 required
LabelArray
object
5 properties 2 required
ContentStateInput
object
4 properties
ContentStateResponse
object
2 properties
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
ContentStateBulkSetTaskUpdate
object
6 properties 4 required
User
objectnull
17 properties 1 required
SpaceDescription
object
3 properties 3 required
MenusLookAndFeel
object
2 properties 2 required
GenericLinks
object
ContentHistory
objectnull
11 properties 1 required
AsyncId
object
1 property 1 required
ContentMetadata
object
Metadata object for page, blogpost, comment content
4 properties
WebResourceDependencies
object
6 properties
UserDetails
object
2 properties
ContainerLookAndFeel
objectnull
12 properties 6 required
Version
objectnull
14 properties 3 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
AvailableContentStates
object
2 properties 2 required
UserArray
object
6 properties 1 required
NavigationLookAndFeel
objectnull
3 properties 2 required
ContentStateFailure
object
Object describing why a content state set failed
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-content-states-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Content States API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.