\"\n }\n}\n```\n\nWhen additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of results returned in each call.\nExample subsequent call (taken from example response):\n```\n/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg\n```\nThe response to this will have a `prev` URL similar to the `next` in the example response.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).\nOnly content that the user has permission to view will be returned.","operationId":"searchContentByCQL","parameters":[{"name":"cql","in":"query","description":"The CQL string that is used to find the requested content.","required":true,"schema":{"type":"string"}},{"name":"cqlcontext","in":"query","description":"The space, content, and content status to execute the search against.\nSpecify this as an object with the following properties:\n\n- `spaceKey` Key of the space to search against. Optional.\n- `contentId` ID of the content to search against. Optional. Must\nbe in the space spacified by `spaceKey`.\n- `contentStatuses` Content statuses to search against. Optional.","schema":{"type":"string"}},{"$ref":"#/components/parameters/contentExpand"},{"name":"cursor","in":"query","description":"Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of content objects to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested list of content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"400":{"description":"Returned if the CQL is invalid or missing.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["search:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["search:confluence"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}":{"get":{"tags":["Content"],"summary":"Get content by ID","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns a single piece of content, like a page or a blog post.\n\nBy default, the following objects are expanded: `space`, `history`, `version`.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content. If the content is a blog post, 'View' permission\nfor the space is required.","operationId":"getContentById","parameters":[{"name":"id","in":"path","description":"The ID of the content to be returned. If you don't know the content ID,\nuse [Get content](#api-content-get) and filter the results.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter the results to a set of content based on their status.\nIf set to `any`, content with any status is returned. Note, the\n`historical` status is currently not supported.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["current"],"enum":["current","trashed","deleted","historical","draft","any"]}},{"name":"version","in":"query","description":"The version number of the content to be returned.","schema":{"type":"integer","format":"int32"}},{"name":"embeddedContentRender","in":"query","description":"The version of embedded content (e.g. attachments) to render.\n\n- current renders the latest version of the embedded content.\n- version-at-save renders the version of the embedded content\nat the time of save.","schema":{"type":"string","default":"current","enum":["current","version-at-save"]}},{"$ref":"#/components/parameters/contentExpandWithSubExpandLimit"},{"name":"trigger","in":"query","description":"If set to `viewed`, the request will trigger a 'viewed' event for the content.\nWhen this event is triggered, the page/blogpost will appear on the 'Recently visited'\ntab of the user's Confluence dashboard.","schema":{"type":"string","enum":["viewed"]}}],"responses":{"200":{"description":"Returned if the requested content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}}},"400":{"description":"Returned if;\n- The content id is invalid.\n- The sub-expansions limit exceeds.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"403":{"description":"Returned if the calling user can not view the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The requesting user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content"],"summary":"Update content","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nUpdates a piece of content. Use this method to update the title or body\nof a piece of content, change the status, change the parent page, and more.\n\nNote, updating draft content is currently not supported.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"updateContent","parameters":[{"name":"id","in":"path","description":"The ID of the content to be updated.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The updated status of the content. Use this parameter to change the\nstatus of a piece of content without passing the entire request body.","schema":{"type":"string","default":"current","enum":["current","trashed","deleted","historical","draft"]}},{"name":"conflictPolicy","in":"query","description":"The action that should be taken when conflicts are discovered.\nOnly used when publishing a draft page.","schema":{"type":"string","default":"abort","enum":["abort"]}}],"requestBody":{"description":"The updated content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the content is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}}},"400":{"description":"Returned if;\n\n- The request body is missing required parameters (version, type, title).\n- The type property has been set incorrectly.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the calling user can not update the content with specified id.","content":{}},"404":{"description":"Returned if a draft with current content cannot be found when setting the status\nparameter to draft and the content status is current.","content":{}},"409":{"description":"Returned if;\n\n- The page is a draft (draft pages cannot be updated).\n- The version property has not been set correctly for the content\ntype.","content":{}},"501":{"description":"Indicates that the server does not support the functionality needed to serve the request.\nFor example,\n\n- trying to publish edit draft and passing content status as historical.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"content","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content"],"summary":"Delete content","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nMoves a piece of content to the space's trash or purges it from the trash,\ndepending on the content's type and status:\n\n- If the content's type is `page`,`blogpost`, or `attachment` and its status is `current`,\nit will be trashed.\n- If the content's type is `page`,`blogpost`, or `attachment` and its status is `trashed`,\nthe content will be purged from the trash and deleted permanently. Note,\nyou must also set the `status` query parameter to `trashed` in your request.\n- If the content's type is `comment`, it will be deleted\npermanently without being trashed.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Delete' permission for the space that the content is in.","operationId":"deleteContent","parameters":[{"name":"id","in":"path","description":"The ID of the content to be deleted.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Set this to `trashed`, if the content's status is `trashed` and you want to purge it.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the content is successfully trashed or purged.","content":{}},"400":{"description":"Returned if the content id is invalid.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the calling user can not delete the content with specified id.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The requesting user does not have permission to trash or purge the\ncontent.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["delete:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/content/{id}/pageTree":{"delete":{"tags":["Experimental"],"summary":"Delete page tree","description":"Moves a pagetree rooted at a page to the space's trash:\n\n- If the content's type is `page` and its status is `current`, it will be trashed including\nall its descendants.\n- For every other combination of content type and status, this API is not supported.\n\nThis API accepts the pageTree delete request and returns a task ID.\nThe delete process happens asynchronously.\n\n Response example:\n \n {\n \"id\" : \"1180606\",\n \"links\" : {\n \"status\" : \"/rest/api/longtask/1180606\"\n }\n }\n
\n Use the `/longtask/` REST API to get the copy task status.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Delete' permission for the space that the content is in.","operationId":"deletePageTree","parameters":[{"name":"id","in":"path","description":"The ID of the content which forms root of the page tree, to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if the request to trash content and all its current page descendants, is successfully accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongTask"}}}},"400":{"description":"Returned if the content id is invalid or id does not represents a 'CURRENT' page.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the calling user can not delete the content with specified id.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The requesting user does not have permission to trash the content or any of it's descendant pages.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["delete:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/content/{id}/child":{"get":{"tags":["Content - children and descendants"],"summary":"Get content children","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns a map of the direct children of a piece of content. A piece of content\nhas different types of child content, depending on its type. These are\nthe default parent-child content type relationships:\n\n- `page`: child content is `page`, `comment`, `attachment`\n- `blogpost`: child content is `comment`, `attachment`\n- `attachment`: child content is `comment`\n- `comment`: child content is `attachment`\n\nApps can override these default relationships. Apps can also introduce\nnew content types that create new parent-child content relationships.\n\nNote, the map will always include all child content types that are valid\nfor the content. However, if the content has no instances of a child content\ntype, the map will contain an empty array for that child content type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space,\nand permission to view the content if it is a page.","operationId":"getContentChildren","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its children.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the children to expand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content.\n- Custom content types that are provided by apps are also supported.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"parentVersion","in":"query","description":"The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version.","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Returned if the requested content children are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentChildren"}}}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{pageId}/move/{position}/{targetId}":{"put":{"tags":["Content - children and descendants"],"summary":"Move a page to a new location relative to a target page","description":"Move a page to a new location relative to a target page:\n\n* `before` - move the page under the same parent as the target, before the target in the list of children\n* `after` - move the page under the same parent as the target, after the target in the list of children\n* `append` - move the page to be a child of the target\n\nCaution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI\nbecause they do not show up in the page tree display. To avoid this, never use `before` or `after` positions\nwhen the `targetId` is a top-level page.","operationId":"movePage","parameters":[{"name":"pageId","in":"path","description":"The ID of the page to be moved","required":true,"schema":{"type":"string"}},{"name":"position","in":"path","description":"The position to move the page to relative to the target page:\n* `before` - move the page under the same parent as the target, before the target in the list of children\n* `after` - move the page under the same parent as the target, after the target in the list of children\n* `append` - move the page to be a child of the target","required":true,"schema":{"type":"string","enum":["before","after","append"]}},{"name":"targetId","in":"path","description":"The ID of the target page for this operation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Page was successfully moved","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"$ref":"#/components/schemas/ContentId"}}}}}},"400":{"description":"Returned if;\n\n- A page already exists in the target space with the same name.\n User is advised to rename page before moving.\n- The move would create a parent-child loop (page becomes a descendant and ancestor of itself)\n- The page has permission restrictions that the user does not have permission to create in the target space.\n User is advised to remove restrictions before moving.","content":{}},"403":{"description":"Returned if;\n\n- User does not have permission to remove page from current space\n- User does not have permission to create a page in target space","content":{}},"404":{"description":"Returned if;\n\n- The id or targetId refer to non-existent pages","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:page:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/child/attachment":{"get":{"tags":["Content - attachments"],"summary":"Get attachments","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns the attachments for a piece of content.\n\nBy default, the following objects are expanded: `metadata`.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content. If the content is a blog post, 'View' permission\nfor the space is required.","operationId":"getAttachments","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its attachments.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/contentExpand"},{"name":"start","in":"query","description":"The starting index of the returned attachments.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of attachments to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}},{"name":"filename","in":"query","description":"Filter the results to attachments that match the filename.","schema":{"type":"string"}},{"name":"mediaType","in":"query","description":"Filter the results to attachments that match the media type.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested attachments are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"404":{"description":"Returned if;\n\n- There is no parent content with the given ID.\n- The calling user does not have permission to view the parent content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content - attachments"],"summary":"Create or update attachment","description":"Adds an attachment to a piece of content. If the attachment already exists\nfor the content, then the attachment is updated (i.e. a new version of the\nattachment is created).\n\nNote, you must set a `X-Atlassian-Token: nocheck` header on the request\nfor this method, otherwise it will be blocked. This protects against XSRF\nattacks, which is necessary as this method accepts multipart/form-data.\n\nThe media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt).\nMost client libraries have classes that make it easier to implement\nmultipart posts, like the [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)\nJava class provided by Apache HTTP Components.\n\nNote, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),\nin the case where the form data is text,\nthe charset parameter for the \"text/plain\" Content-Type may be used to\nindicate the character encoding used in that part. In the case of this\nAPI endpoint, the `comment` body parameter should be sent with `type=text/plain`\nand `charset=utf-8` values. This will force the charset to be UTF-8.\n\nExample: This curl command attaches a file ('example.txt') to a piece of\ncontent (id='123') with a comment and `minorEdits`=true. If the 'example.txt'\nfile already exists, it will update it with a new version of the attachment.\n\n``` bash\ncurl -D- \\\n -u admin:admin \\\n -X PUT \\\n -H 'X-Atlassian-Token: nocheck' \\\n -F 'file=@\"example.txt\"' \\\n -F 'minorEdit=\"true\"' \\\n -F 'comment=\"Example attachment comment\"; type=text/plain; charset=utf-8' \\\n http://myhost/rest/api/content/123/child/attachment\n```\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"createOrUpdateAttachments","parameters":[{"name":"id","in":"path","description":"The ID of the content to add the attachment to.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The status of the content that the attachment is being added to.\nThis should always be set to 'current'.","schema":{"type":"string","default":"current","enum":["current","draft"]}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","minorEdit"],"properties":{"file":{"type":"string","description":"The relative location and name of the attachment to be added to\nthe content.","format":"binary"},"comment":{"type":"string","description":"The comment for the attachment that is being added.\nIf you specify a comment, then every file must have a comment and\nthe comments must be in the same order as the files. Alternatively,\ndon't specify any comments.","format":"binary"},"minorEdit":{"type":"string","description":"If `minorEdits` is set to 'true', no notification email or activity stream\nwill be generated when the attachment is added to the content.","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"Returned if the attachments were added to the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"403":{"description":"Returned if;\n\n- Attachments are disabled.\n- The calling user does not have permission to add attachments to the\ncontent.","content":{}},"404":{"description":"Returned if;\n\n- The requested content is not found.\n- The user does not have permission to view it.\n- The attachment exceeds the maximum configured attachment size.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-file"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-file"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:attachment:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"post":{"tags":["Content - attachments"],"summary":"Create attachment","description":"Adds an attachment to a piece of content. This method only adds a new\nattachment. If you want to update an existing attachment, use\n[Create or update attachments](#api-content-id-child-attachment-put).\n\nNote, you must set a `X-Atlassian-Token: nocheck` header on the request\nfor this method, otherwise it will be blocked. This protects against XSRF\nattacks, which is necessary as this method accepts multipart/form-data.\n\nThe media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt).\nMost client libraries have classes that make it easier to implement\nmultipart posts, like the [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)\nJava class provided by Apache HTTP Components.\n\nNote, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),\nin the case where the form data is text,\nthe charset parameter for the \"text/plain\" Content-Type may be used to\nindicate the character encoding used in that part. In the case of this\nAPI endpoint, the `comment` body parameter should be sent with `type=text/plain`\nand `charset=utf-8` values. This will force the charset to be UTF-8.\n\nExample: This curl command attaches a file ('example.txt') to a container\n(id='123') with a comment and `minorEdits`=true.\n\n``` bash\ncurl -D- \\\n -u admin:admin \\\n -X POST \\\n -H 'X-Atlassian-Token: nocheck' \\\n -F 'file=@\"example.txt\"' \\\n -F 'minorEdit=\"true\"' \\\n -F 'comment=\"Example attachment comment\"; type=text/plain; charset=utf-8' \\\n http://myhost/rest/api/content/123/child/attachment\n```\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"createAttachment","parameters":[{"name":"id","in":"path","description":"The ID of the content to add the attachment to.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The status of the content that the attachment is being added to.","schema":{"type":"string","default":"current","enum":["current","draft"]}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","minorEdit"],"properties":{"file":{"type":"string","description":"The relative location and name of the attachment to be added to\nthe content.","format":"binary"},"comment":{"type":"string","description":"The comment for the attachment that is being added.\nIf you specify a comment, then every file must have a comment and\nthe comments must be in the same order as the files. Alternatively,\ndon't specify any comments.","format":"binary"},"minorEdit":{"type":"string","description":"If `minorEdits` is set to 'true', no notification email or activity stream\nwill be generated when the attachment is added to the content.","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"Returned if the attachments were added to the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"400":{"description":"Returned if the content already has an attachment with the same filename.","content":{}},"403":{"description":"Returned if;\n\n- Attachments are disabled in Confluence.\n- The calling user does not have permission to add attachments to the\ncontent.","content":{}},"404":{"description":"Returned if;\n\n- The requested content is not found.\n- The user does not have permission to view it\n- The attachment exceeds the maximum configured attachment size.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-file"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-file"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:attachment:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/child/attachment/{attachmentId}":{"put":{"tags":["Content - attachments"],"summary":"Update attachment properties","description":"Updates the attachment properties, i.e. the non-binary data of an attachment\nlike the filename, media-type, comment, and parent container.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"updateAttachmentProperties","parameters":[{"name":"id","in":"path","description":"The ID of the content that the attachment is attached to.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"The ID of the attachment to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The details of the attachment to be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentPropertiesUpdateBody"}}},"required":true},"responses":{"200":{"description":"Returned if the attachment is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}}},"400":{"description":"Returned if;\n\n- The attachment id is invalid.\n- The attachment version number is invalid.","content":{}},"403":{"description":"Returned if;\n\n- The calling user is not permitted to update or move the attachment.\n- The attachment is being moved to an invalid content type.","content":{}},"404":{"description":"Returned if no attachment is found for the attachment ID.","content":{}},"409":{"description":"Returned if the version of the supplied attachment does not match\nthe version of the attachment stored in the database.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-file","write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-file","write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:attachment:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data":{"post":{"tags":["Content - attachments"],"summary":"Update attachment data","description":"Updates the binary data of an attachment, given the attachment ID, and\noptionally the comment and the minor edit field.\n\nThis method is essentially the same as [Create or update attachments](#api-content-id-child-attachment-put),\nexcept that it matches the attachment ID rather than the name.\n\nNote, you must set a `X-Atlassian-Token: nocheck` header on the request\nfor this method, otherwise it will be blocked. This protects against XSRF\nattacks, which is necessary as this method accepts multipart/form-data.\n\nThe media type 'multipart/form-data' is defined in [RFC 7578](https://www.ietf.org/rfc/rfc7578.txt).\nMost client libraries have classes that make it easier to implement\nmultipart posts, like the [MultipartEntityBuilder](https://hc.apache.org/httpcomponents-client-5.1.x/current/httpclient5/apidocs/)\nJava class provided by Apache HTTP Components.\n\nNote, according to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.5),\nin the case where the form data is text,\nthe charset parameter for the \"text/plain\" Content-Type may be used to\nindicate the character encoding used in that part. In the case of this\nAPI endpoint, the `comment` body parameter should be sent with `type=text/plain`\nand `charset=utf-8` values. This will force the charset to be UTF-8.\n\nExample: This curl command updates an attachment (id='att456') that is attached\nto a piece of content (id='123') with a comment and `minorEdits`=true.\n\n``` bash\ncurl -D- \\\n -u admin:admin \\\n -X POST \\\n -H 'X-Atlassian-Token: nocheck' \\\n -F 'file=@\"example.txt\"' \\\n -F 'minorEdit=\"true\"' \\\n -F 'comment=\"Example attachment comment\"; type=text/plain; charset=utf-8' \\\n http://myhost/rest/api/content/123/child/attachment/att456/data\n```\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"updateAttachmentData","parameters":[{"name":"id","in":"path","description":"The ID of the content that the attachment is attached to.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"The ID of the attachment to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","minorEdit"],"properties":{"file":{"type":"string","description":"The relative location and name of the attachment to be added to\nthe content.","format":"binary"},"comment":{"type":"string","description":"The comment for the attachment that is being added.\nIf you specify a comment, then every file must have a comment and\nthe comments must be in the same order as the files. Alternatively,\ndon't specify any comments.","format":"binary"},"minorEdit":{"type":"string","description":"If `minorEdits` is set to 'true', no notification email or activity stream\nwill be generated when the attachment is added to the content.","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"Returned if the attachment is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}}},"400":{"description":"Returned if the attachment id is invalid.","content":{}},"404":{"description":"Returned if no attachment is found for the attachment ID.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-file"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-file"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:attachment:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download":{"get":{"tags":["Content - attachments"],"summary":"Get URI to download attachment","description":"Redirects the client to a URL that serves an attachment's binary data.","operationId":"downloadAttatchment","parameters":[{"name":"id","in":"path","description":"The ID of the content that the attachment is attached to.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"The ID of the attachment to download.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the attachment. If this parameter is absent, the redirect URI will download the latest version of the attachment.","schema":{"type":"integer"}}],"responses":{"302":{"description":"Returned if download URL is found."},"400":{"description":"Returned if version number is greater than attachment's latest version number or an invalid value."},"401":{"description":"Returned if there are authentication issues in request."},"404":{"description":"Returned if;\n\n- No content is found with the specified content ID.\n- The specified content does not contain an attachment with the specified attachment ID.\n- The calling user does not have permission to view the attachment."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["readonly:content.attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["readonly:content.attachment:confluence"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:attachment:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/child/comment":{"get":{"tags":["Content comments"],"summary":"Get content comments","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns the comments on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space,\nand permission to view the content if it is a page.","operationId":"getContentComments","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its comments.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/contentExpand"},{"name":"parentVersion","in":"query","description":"The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"start","in":"query","description":"The starting index of the returned comments.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"The maximum number of comments to return per page. Note,\nthis may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}},{"name":"location","in":"query","description":"The location of the comments in the page. Multiple locations can be specified.\nIf no location is specified, comments from all locations are returned.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"enum":["inline","footer","resolved"]}},{"name":"depth","in":"query","description":"Currently, this parameter is not used.\nComments are returned at the root level only.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested comments are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"404":{"description":"Returned if;\n\n- There is no parent content with the given ID.\n- The calling user does not have permission to view the parent content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/child/{type}":{"get":{"tags":["Content - children and descendants"],"summary":"Get content children by type","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns all children of a given type, for a piece of content.\nA piece of content has different types of child content, depending on its type:\n\n- `page`: child content is `page`, `comment`, `attachment`\n- `blogpost`: child content is `comment`, `attachment`\n- `attachment`: child content is `comment`\n- `comment`: child content is `attachment`\n\nCustom content types that are provided by apps can also be returned.\n\nNote, this method only returns direct children. To return children at all\nlevels, use [Get descendants by type](#api-content-id-descendant-type-get).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space,\nand permission to view the content if it is a page.","operationId":"getContentChildrenByType","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its children.","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The type of children to return.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/contentExpand"},{"name":"parentVersion","in":"query","description":"The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"start","in":"query","description":"The starting index of the returned content.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"The maximum number of content to return per page. Note,\nthis may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"400":{"description":"Returned if the parent type and desired child content type are not compatible.\nEg: Cannot find `page` children of a `blogpost`.","content":{}},"404":{"description":"Returned if:\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/descendant":{"get":{"tags":["Content - children and descendants"],"summary":"Get content descendants","description":"Returns a map of the descendants of a piece of content. This is similar\nto [Get content children](#api-content-id-child-get), except that this\nmethod returns child pages at all levels, rather than just the direct\nchild pages.\n\nA piece of content has different types of descendants, depending on its type:\n\n- `page`: descendant is `page`, `comment`, `attachment`\n- `blogpost`: descendant is `comment`, `attachment`\n- `attachment`: descendant is `comment`\n- `comment`: descendant is `attachment`\n\nThe map will always include all descendant types that are valid for the content.\nHowever, if the content has no instances of a descendant type, the map will\ncontain an empty array for that descendant type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space, and permission to view the content if it\nis a page.","operationId":"getContentDescendants","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its descendants.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the children to\nexpand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["attachment","comment","page"]}}}],"responses":{"200":{"description":"Returned if the requested descendants are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentChildren"}}}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/descendant/{type}":{"get":{"tags":["Content - children and descendants"],"summary":"Get content descendants by type","description":"Returns all descendants of a given type, for a piece of content. This is\nsimilar to [Get content children by type](#api-content-id-child-type-get),\nexcept that this method returns child pages at all levels, rather than just\nthe direct child pages.\n\nA piece of content has different types of descendants, depending on its type:\n\n- `page`: descendant is `page`, `comment`, `attachment`\n- `blogpost`: descendant is `comment`, `attachment`\n- `attachment`: descendant is `comment`\n- `comment`: descendant is `attachment`\n\nCustom content types that are provided by apps can also be returned.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space, and permission to view the content if it\nis a page.","operationId":"getDescendantsOfType","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its descendants.","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The type of descendants to return.","required":true,"schema":{"type":"string","enum":["page","comment","attachment"]}},{"name":"depth","in":"query","description":"Filter the results to descendants upto a desired level of the content. Note, the maximum value supported is 100. root level of the content means immediate (level 1) descendants of the type requested. all represents returning all descendants of the type requested.","schema":{"type":"string","default":"all","enum":["all","root",""]}},{"$ref":"#/components/parameters/contentExpand"},{"name":"start","in":"query","description":"The starting index of the returned content.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of content to return per page. Note,\nthis may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"400":{"description":"Returned if;\n\n- Any of the required request params are missing.\n- The request is invalid such as negative start param, a format besides int32 for limit etc.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/history":{"get":{"tags":["Content"],"summary":"Get content history","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns the most recent update for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.","operationId":"getHistoryForContent","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its history.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content history to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `lastUpdated` returns information about the most recent update of the content,\nincluding who updated it and when it was updated.\n- `previousVersion` returns information about the update prior to the current content\nupdate. For this method, it contains the same information as `lastUpdated`.\n- `contributors` returns all of the users who have contributed to the content.\n- `nextVersion` This parameter is not used for this method.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["lastUpdated","previousVersion","contributors","nextVersion"]}}}],"responses":{"200":{"description":"Returned if the requested content history is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentHistory"}}}},"400":{"description":"Returned if sub-expansions limit exceeds.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence","read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}":{"get":{"tags":["Content - macro body"],"summary":"Get macro body by macro ID","description":"Returns the body of a macro in storage format, for the given macro ID.\nThis includes information like the name of the macro, the body of the macro,\nand any macro parameters. This method is mainly used by Cloud apps.\n\nAbout the macro ID: When a macro is created in a new version of content,\nConfluence will generate a random ID for it, unless an ID is specified\n(by an app). The macro ID will look similar to this: '50884bd9-0cb8-41d5-98be-f80943c14f96'.\nThe ID is then persisted as new versions of content are created, and is\nonly modified by Confluence if there are conflicting IDs.\n\nNote, to preserve backwards compatibility this resource will also match on\nthe hash of the macro body, even if a macro ID is found. This check will\neventually become redundant, as macro IDs are generated for pages and\ntransparently propagate out to all instances.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content that the macro is in.","operationId":"getMacroBodyByMacroId","parameters":[{"name":"id","in":"path","description":"The ID for the content that contains the macro.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"The version of the content that contains the macro. Specifying `0` as the `version` will return\nthe macro body for the latest content version.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"macroId","in":"path","description":"The ID of the macro. This is usually passed by the app that the\nmacro is in. Otherwise, find the macro ID by querying the desired\ncontent and version, then expanding the body in storage format.\nFor example, '/content/196611/version/7?expand=content.body.storage'.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested macro body is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacroInstance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- The macro does not exist in the specified version.\n- There is no macro matching the given macro ID or hash.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}":{"get":{"tags":["Content - macro body"],"summary":"Get macro body by macro ID and convert the representation synchronously","description":"Returns the body of a macro in format specified in path, for the given macro ID.\nThis includes information like the name of the macro, the body of the macro,\nand any macro parameters.\n\nAbout the macro ID: When a macro is created in a new version of content,\nConfluence will generate a random ID for it, unless an ID is specified\n(by an app). The macro ID will look similar to this: '50884bd9-0cb8-41d5-98be-f80943c14f96'.\nThe ID is then persisted as new versions of content are created, and is\nonly modified by Confluence if there are conflicting IDs.\n\nNote, to preserve backwards compatibility this resource will also match on\nthe hash of the macro body, even if a macro ID is found. This check will\neventually become redundant, as macro IDs are generated for pages and\ntransparently propagate out to all instances.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content that the macro is in.","operationId":"getAndConvertMacroBodyByMacroId","parameters":[{"name":"id","in":"path","description":"The ID for the content that contains the macro.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"The version of the content that contains the macro. Specifying `0` as the `version` will return\nthe macro body for the latest content version.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"macroId","in":"path","description":"The ID of the macro. This is usually passed by the app that the\nmacro is in. Otherwise, find the macro ID by querying the desired\ncontent and version, then expanding the body in storage format.\nFor example, '/content/196611/version/7?expand=content.body.storage'.","required":true,"schema":{"type":"string"}},{"name":"to","in":"path","required":true,"description":"The content representation to return the macro in.","schema":{"type":"string"}},{"$ref":"#/components/parameters/bodyConversionExpand"},{"name":"spaceKeyContext","in":"query","description":"The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link ``\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space.","schema":{"type":"string"}},{"name":"embeddedContentRender","in":"query","description":"Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save.","schema":{"type":"string","default":"current","enum":["current","version-at-save"]}}],"responses":{"200":{"description":"Returned if the requested content body is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentBody"}}}},"400":{"description":"Returned if invalid content representation is requested, or context is missing."},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- The macro does not exist in the specified version.\n- There is no macro matching the given macro ID or hash.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}":{"get":{"tags":["Content - macro body"],"summary":"Get macro body by macro ID and convert representation Asynchronously","description":"Returns Async Id of the conversion task which will convert the macro into a content body of the desired format.\nThe result will be available for 5 minutes after completion of the conversion.\n\nAbout the macro ID: When a macro is created in a new version of content,\nConfluence will generate a random ID for it, unless an ID is specified\n(by an app). The macro ID will look similar to this: '884bd9-0cb8-41d5-98be-f80943c14f96'.\nThe ID is then persisted as new versions of content are created, and is\nonly modified by Confluence if there are conflicting IDs.\n\nNote, to preserve backwards compatibility this resource will also match on\nthe hash of the macro body, even if a macro ID is found. This check will\neventually become redundant, as macro IDs are generated for pages and\ntransparently propagate out to all instances.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content that the macro is in.","operationId":"getAndAsyncConvertMacroBodyByMacroId","parameters":[{"name":"id","in":"path","description":"The ID for the content that contains the macro.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"The version of the content that contains the macro. Specifying `0` as the `version` will return\nthe macro body for the latest content version.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"macroId","in":"path","description":"The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework.\nOtherwise, find the macro ID by querying the desired\ncontent and version, then expanding the body in storage format.\nFor example, '/content/196611/version/7?expand=content.body.storage'.","required":true,"schema":{"type":"string"}},{"name":"to","in":"path","required":true,"description":"The content representation to return the macro in.\nCurrently, the following conversions are allowed:\n\n- `export_view`\n- `styled_view`\n- `view`","schema":{"type":"string","enum":["export_view","view","styled_view"]}},{"$ref":"#/components/parameters/bodyConversionExpand"},{"name":"allowCache","in":"query","description":"If this field is false, the cache will erase its current value and begin a conversion.\nIf this field is true, the cache will not erase its current value, and will set the status of the\nresult in cache to RERUNNING. Once the data is updated, the status will change to COMPLETED. \nLarge macros that take long to convert, and who want to show intermediate, but potentially stale data, immediately should set this field to true.\nCache values are stored per macro per user per content and expansions.","schema":{"type":"boolean","default":false}},{"name":"spaceKeyContext","in":"query","description":"The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link ``\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space.","schema":{"type":"string"}},{"name":"embeddedContentRender","in":"query","description":"Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save.","schema":{"type":"string","default":"current","enum":["current","version-at-save"]}}],"responses":{"200":{"description":"Returned if the requested macro conversion request is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncId"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- The macro does not exist in the specified version.\n- There is no macro matching the given macro ID or hash.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/label":{"get":{"tags":["Content labels"],"summary":"Get labels for content","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns the labels on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space and permission to view the content if it is a page.","operationId":"getLabelsForContent","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its labels.","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"Filters the results to labels with the specified prefix. If this parameter\nis not specified, then labels with any prefix will be returned.\n\n- `global` prefix is used by default when a user adds a label\nvia the UI.\n- `my` prefix can be explicitly added by a user when adding a label\nvia the UI, e.g. 'my:example-label'. Also, when a page is selected as\na favourite, the 'my:favourite' label is automatically added.\n- `team` can used when adding labels via [Add labels to content](#api-content-id-label-post)\nbut is not used in the UI.","schema":{"type":"string","enum":["global","my","team"]}},{"name":"start","in":"query","description":"The starting index of the returned labels.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of labels to return per page. Note,\nthis may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the requested labels are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelArray"}}}},"403":{"description":"Returned if the calling user can view but not edit the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Content labels"],"summary":"Add labels to content","description":"Adds labels to a piece of content. Does not modify the existing labels.\n\nNotes:\n\n- Labels can also be added when creating content ([Create content](#api-content-post)).\n- Labels can be updated when updating content ([Update content](#api-content-id-put)).\nThis will delete the existing labels and replace them with the labels in\nthe request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"addLabelsToContent","parameters":[{"name":"id","in":"path","description":"The ID of the content that will have labels added to it.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The labels to add to the content.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LabelCreateArray"},{"$ref":"#/components/schemas/LabelCreate"}]}}},"required":true},"responses":{"200":{"description":"Returned if the labels are added to the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelArray"}}}},"400":{"description":"Returned if;\n\n- The body contains labels with invalid characters or too many characters.\n- The body contains too many labels.\n- The target content would contain too many labels after the operation.\n- The calling user does not have permission to edit labels.","content":{}},"403":{"description":"Returned if the calling user can view but not edit the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:label:confluence","write:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content labels"],"summary":"Remove label from content using query parameter","description":"Removes a label from a piece of content. Labels can't be deleted from archived content.\nThis is similar to [Remove label from content](#api-content-id-label-label-delete)\nexcept that the label name is specified via a query parameter.\n\nUse this method if the label name has \"/\" characters, as\n[Remove label from content using query parameter](#api-content-id-label-delete)\ndoes not accept \"/\" characters for the label name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"removeLabelFromContentUsingQueryParameter","parameters":[{"name":"id","in":"path","description":"The ID of the content that the label will be removed from.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The name of the label to be removed.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the label is removed. The response body will be empty.","content":{}},"403":{"description":"Returned if the calling user can view but not edit the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/label/{label}":{"delete":{"tags":["Content labels"],"summary":"Remove label from content","description":"Removes a label from a piece of content. Labels can't be deleted from archived content.\nThis is similar to [Remove label from content using query parameter](#api-content-id-label-delete)\nexcept that the label name is specified via a path parameter.\n\nUse this method if the label name does not have \"/\" characters, as the path\nparameter does not accept \"/\" characters for security reasons. Otherwise,\nuse [Remove label from content using query parameter](#api-content-id-label-delete).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"removeLabelFromContent","parameters":[{"name":"id","in":"path","description":"The ID of the content that the label will be removed from.","required":true,"schema":{"type":"string"}},{"name":"label","in":"path","description":"The name of the label to be removed.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the label is removed. The response body will be empty.","content":{}},"400":{"description":"Returned if the label name has a \"/\" character.","content":{}},"403":{"description":"Returned if the calling user can view but not edit the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/notification/child-created":{"get":{"tags":["Content watches"],"summary":"Get watches for page","description":"Returns the watches for a page. A user that watches a page will receive\nreceive notifications when the page is updated.\n\nIf you want to manage watches for a page, use the following `user` methods:\n\n- [Get content watch status for user](#api-user-watch-content-contentId-get)\n- [Add content watch](#api-user-watch-content-contentId-post)\n- [Remove content watch](#api-user-watch-content-contentId-delete)\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getWatchesForPage","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its watches.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned watches.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of watches to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the requested watches are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchArray"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:watcher:confluence","read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/notification/created":{"get":{"tags":["Content watches"],"summary":"Get watches for space","description":"Returns all space watches for the space that the content is in. A user that\nwatches a space will receive receive notifications when any content in the\nspace is updated.\n\nIf you want to manage watches for a space, use the following `user` methods:\n\n- [Get space watch status for user](#api-user-watch-space-spaceKey-get)\n- [Add space watch](#api-user-watch-space-spaceKey-post)\n- [Remove space watch](#api-user-watch-space-spaceKey-delete)\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getWatchesForSpace","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its watches.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned watches.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of watches to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the requested watches are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceWatchArray"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:watcher:confluence","read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/pagehierarchy/copy":{"post":{"tags":["Content - children and descendants"],"summary":"Copy page hierarchy","description":"Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.\n The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body.\n The titleOptions object defines the rules of renaming page titles during the copy;\n for example, search and replace can be used in conjunction to rewrite the copied page titles.\n\n Response example:\n \n {\n \"id\" : \"1180606\",\n \"links\" : {\n \"status\" : \"/rest/api/longtask/1180606\"\n }\n }\n
\n Use the /longtask/ REST API to get the copy task status.","operationId":"copyPageHierarchy","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request object from json post body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyPageHierarchyRequest"}}},"required":true},"responses":{"202":{"description":"Returns a full JSON representation of a long running task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongTask"}}}},"400":{"description":"Returned if the title prefix is invalid (e.g. is empty, creates a conflict)","content":{}},"403":{"description":"Returned if the user does not have permission to create content at destination","content":{}},"404":{"description":"Returned if original page or destination page does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence","write:page:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"request","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/copy":{"post":{"tags":["Content - children and descendants"],"summary":"Copy single page","description":"Copies a single page and its associated properties, permissions, attachments, and custom contents.\n The `id` path parameter refers to the content ID of the page to copy. The target of the page to be copied\n is defined using the `destination` in the request body and can be one of the following types.\n\n - `space`: page will be copied to the specified space as a root page on the space\n - `parent_page`: page will be copied as a child of the specified parent page\n - `existing_page`: page will be copied and replace the specified page\n\nBy default, the following objects are expanded: `space`, `history`, `version`.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add' permission for the space that the content will be copied in and permission to update the content if copying to an `existing_page`.","operationId":"copyPage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/contentExpandWithSubExpandLimit"}],"requestBody":{"description":"Request object from json post body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyPageRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the content is copied.","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Content"}}}},"400":{"description":"Returned if;\n\n- destination or any of its fields are not specified.\n- destination.type is invalid.\n- sub-expansions limit exceeds.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user does not have permission to create content at destination.","content":{}},"404":{"description":"Returned if;\n\n- the original page doesn't exist.\n- the destination page doesn’t exist.\n- the destination space doesn’t exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:page:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"request","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/permission/check":{"post":{"tags":["Content permissions"],"summary":"Check content permissions","description":"Check if a user or a group can perform an operation to the specified content. The `operation` to check\nmust be provided. The user’s account ID or the ID of the group can be provided in the `subject` to check\npermissions against a specified user or group. The following permission checks are done to make sure that the\nuser or group has the proper access:\n\n- site permissions\n- space permissions\n- content restrictions\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission) if checking permission for self,\notherwise 'Confluence Administrator' global permission is required.","operationId":"checkContentPermission","parameters":[{"name":"id","in":"path","description":"The ID of the content to check permissions against.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The content permission request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPermissionRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the permission check completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionCheckResponse"}}}},"400":{"description":"Returned if;\n\n- If any of the required fields are missing.\n- If specified `subject` or `operation` is invalid.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user does not have permission perform the check.","content":{}},"404":{"description":"Returned if there is no content with the given ID.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.permission"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.permission"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/property":{"get":{"tags":["Content properties"],"summary":"Get content properties","deprecated":true,"description":"Returns the properties for a piece of content. For more information\nabout content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space, and permission to view the content if it is a page.","operationId":"getContentProperties","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its properties.","required":true,"schema":{"type":"string"}},{"name":"key","in":"query","description":"The key of the content property.","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["content","version"]}}},{"name":"start","in":"query","description":"The starting index of the returned properties.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of properties to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Returned if the requested properties are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPropertyArray"}}}},"404":{"description":"Returned if;\n\n- There is no content with the given ID\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Content properties"],"summary":"Create content property","deprecated":true,"description":"Creates a property for an existing piece of content. For more information\nabout content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n\nThis is the same as [Create content property for key](#api-content-id-property-key-post)\nexcept that the key is specified in the request body instead of as a\npath parameter.\n\nContent properties can also be added when creating a new piece of content\nby including them in the `metadata.properties` of the request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"createContentProperty","parameters":[{"name":"id","in":"path","description":"The ID of the content to add the property to.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The content property to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPropertyCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the content property is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"400":{"description":"Returned if;\n\n- The content already has a property with the given key.\n- The key is too long.\n- The key is empty.","content":{}},"403":{"description":"Returned if the user does not have permission to edit the content\nwith the given ID.","content":{}},"413":{"description":"Returned if the value is too long.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.property:confluence","write:content.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/property/{key}":{"get":{"tags":["Content properties"],"summary":"Get content property","deprecated":true,"description":"Returns a content property for a piece of content. For more information, see\n[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space, and permission to view the content if it is a page.","operationId":"getContentProperty","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for the property.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the content property.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["content","version"]}}},{"name":"status","in":"query","description":"Filter the results to a set of content based on their status. If set to `any`,\ncontent with any status is returned. By default it will fetch current and archived statuses `?status=current&status=archived`.\nAll supported statuses\n\n- any\n- archived\n- current\n- deleted\n- draft\n- trashed","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"default":["current","archived"],"enum":["any","archived","current","deleted","draft","trashed"]}}],"responses":{"200":{"description":"Returned if the content property is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"404":{"description":"Returned if;\n\n- The calling user does not have permission to view the content.\n- There is no content with the given ID.\n- There is no property with the given key.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content properties"],"summary":"Update content property","deprecated":true,"description":"Updates an existing content property. This method will also create a new\nproperty for a piece of content, if the property key does not exist and\nthe property version is 1. For more information about content properties, see\n[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"updateContentProperty","parameters":[{"name":"id","in":"path","description":"The ID of the content that the property belongs to.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The content property being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPropertyUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the content property is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"400":{"description":"Returned if;\n\n- The content already a property with the given key.\n- The key is too long.\n- The key is empty.","content":{}},"403":{"description":"Returned if the user does not have permission to edit the content\nwith the given ID.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- There is no property with the given key and the version number is not 1.","content":{}},"409":{"description":"Returned if the property version is not correctly incremented.","content":{}},"413":{"description":"Returned if the value is too long.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.property:confluence","write:content.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"post":{"tags":["Content properties"],"summary":"Create content property for key","deprecated":true,"description":"Creates a property for an existing piece of content. For more information\nabout content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n\nThis is the same as [Create content property](#api-content-id-property-post)\nexcept that the key is specified as a path parameter instead of in the\nrequest body.\n\nContent properties can also be added when creating a new piece of content\nby including them in the `metadata.properties` of the request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"createContentPropertyForKey","parameters":[{"name":"id","in":"path","description":"The ID of the content to add the property to.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the content property. Required.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The content property to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPropertyCreateNoKey"}}},"required":true},"responses":{"200":{"description":"Returned if the content property is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"400":{"description":"Returned if;\n\n- The content already has a property with the given key.\n- The key is too long.\n- The key is empty.","content":{}},"403":{"description":"Returned if the user does not have permission to edit the content\nwith the given ID.","content":{}},"413":{"description":"Returned if the value is too long.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.property:confluence","write:content.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content properties"],"summary":"Delete content property","deprecated":true,"description":"Deletes a content property. For more information about content properties, see\n[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"deleteContentProperty","parameters":[{"name":"id","in":"path","description":"The ID of the content that the property belongs to.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the property.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the content property is deleted.","content":{}},"403":{"description":"Returned if the user does not have permission to delete content\nwith the given ID.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/restriction":{"get":{"tags":["Content restrictions"],"summary":"Get restrictions","description":"Returns the restrictions on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getRestrictions","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its restrictions.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content\nrestrictions to expand. By default, the following objects are expanded:\n`restrictions.user`, `restrictions.group`.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to.\n- `content` returns the piece of content that the restrictions are\napplied to.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["restrictions.user","read.restrictions.user","update.restrictions.user","restrictions.group","read.restrictions.group","update.restrictions.group","content"]}}},{"name":"start","in":"query","description":"The starting index of the users and groups in the returned restrictions.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of users and the maximum number of groups, in the\nreturned restrictions, to return per page. Note, this may be restricted\nby fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the requested restrictions are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestrictionArray"}}}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content restrictions"],"summary":"Update restrictions","description":"Updates restrictions for a piece of content. This removes the existing\nrestrictions and replaces them with the restrictions in the request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"updateRestrictions","parameters":[{"name":"id","in":"path","description":"The ID of the content to update restrictions for.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["restrictions.user","read.restrictions.user","update.restrictions.user","restrictions.group","read.restrictions.group","update.restrictions.group","content"]}}}],"requestBody":{"description":"The updated restrictions for the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestrictionAddOrUpdateArray"}}},"required":true},"responses":{"200":{"description":"Returned if the requested restrictions are updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestrictionArray"}}}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to update restrictions\nfor the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"post":{"tags":["Content restrictions"],"summary":"Add restrictions","description":"Adds restrictions to a piece of content. Note, this does not change any\nexisting restrictions on the content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"addRestrictions","parameters":[{"name":"id","in":"path","description":"The ID of the content to add restrictions to.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["restrictions.user","read.restrictions.user","update.restrictions.user","restrictions.group","read.restrictions.group","update.restrictions.group","content"]}}}],"requestBody":{"description":"The restrictions to be added to the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestrictionAddOrUpdateArray"}}},"required":true},"responses":{"200":{"description":"Returned if the requested restrictions are added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestrictionArray"}}}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to add restrictions to\nthe content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content restrictions"],"summary":"Delete restrictions","description":"Removes all restrictions (read and update) on a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"deleteRestrictions","parameters":[{"name":"id","in":"path","description":"The ID of the content to remove restrictions from.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content\nrestrictions (returned in response) to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["restrictions.user","read.restrictions.user","update.restrictions.user","restrictions.group","read.restrictions.group","update.restrictions.group","content"]}}}],"responses":{"200":{"description":"Returned if the restrictions are removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestrictionArray"}}}},"400":{"description":"Returned if any of the above validation rules are violated","content":{}},"403":{"description":"Returned if the calling user does not have permission to alter the\nrestrictions on the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/content/{id}/restriction/byOperation":{"get":{"tags":["Content restrictions"],"summary":"Get restrictions by operation","description":"Returns restrictions on a piece of content by operation. This method is\nsimilar to [Get restrictions](#api-content-id-restriction-get) except that\nthe operations are properties of the return object, rather than items in\na results array.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getRestrictionsByOperation","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its restrictions.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content\nrestrictions to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["restrictions.user","restrictions.group","content"]}}}],"responses":{"200":{"description":"Returned if the requested restrictions are returned.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"properties":{"operationType":{"$ref":"#/components/schemas/ContentRestriction"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}}}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}":{"get":{"tags":["Content restrictions"],"summary":"Get restrictions for operation","description":"Returns the restictions on a piece of content for a given operation (read\nor update).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getRestrictionsForOperation","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its restrictions.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation type of the restrictions to be returned.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content\nrestrictions to expand.\n\n- `restrictions.user` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `restrictions.group` returns the piece of content that the restrictions are\napplied to. Expanded by default.\n- `content` returns the piece of content that the restrictions are\napplied to.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["restrictions.user","restrictions.group","content"]}}},{"name":"start","in":"query","description":"The starting index of the users and groups in the returned restrictions.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of users and the maximum number of groups, in the\nreturned restrictions, to return per page. Note, this may be restricted\nby fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the requested restrictions are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRestriction"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}":{"get":{"tags":["Content restrictions"],"summary":"Get content restriction status for group","deprecated":true,"description":"Deprecated, use [Get content restriction status for group via groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-get).\nReturns whether the specified content restriction applies to a group.\nFor example, if a page with `id=123` has a `read` restriction for the `admins` group,\nthe following request will return `true`:\n\n`/wiki/rest/api/content/123/restriction/byOperation/read/group/admins`\n\nNote that a response of `true` does not guarantee that the group can view the page, as it does not account for\naccount-inherited restrictions, space permissions, or even product access. For more\ninformation, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getContentRestrictionStatusForGroup","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"groupName","in":"path","description":"The name of the group to be queried for whether the content restriction\napplies to it.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns true if the content restriction applies to the group. The response\nwill not return a response body.","content":{}},"400":{"description":"Returned if;\n\n- Group name is missing","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or group is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content restrictions"],"summary":"Add group to content restriction","deprecated":true,"description":"Deprecated, use [Add group to content restriction via groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-put).\nAdds a group to a content restriction. That is, grant read or update\npermission to the group for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"addGroupToContentRestriction","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"groupName","in":"path","description":"The name of the group to add to the content restriction.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the group is added to the content restriction. The response\nbody will be empty.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or group is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content restrictions"],"summary":"Remove group from content restriction","deprecated":true,"description":"Deprecated, use [Remove group from content restriction by groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-user-delete).\nRemoves a group from a content restriction. That is, remove read or update\npermission for the group for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"removeGroupFromContentRestrictionById","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"groupName","in":"path","description":"The name of the group to remove from the content restriction.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the group is removed from the content restriction. The response\nbody will be empty.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- The restriction to be deleted does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}":{"get":{"tags":["Content restrictions"],"summary":"Get content restriction status for group","description":"Returns whether the specified content restriction applies to a group.\nFor example, if a page with `id=123` has a `read` restriction for the `123456` group id,\nthe following request will return `true`:\n\n`/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456`\n\nNote that a response of `true` does not guarantee that the group can view the page, as it does not account for\naccount-inherited restrictions, space permissions, or even product access. For more\ninformation, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getIndividualGroupRestrictionStatusByGroupId","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"groupId","in":"path","description":"The id of the group to be queried for whether the content restriction\napplies to it.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns true if the content restriction applies to the group. The response\nwill not return a response body.","content":{}},"403":{"description":"Returned if the calling user does not have permission to view the\ncontent.","content":{}},"404":{"description":"Returned if\n- There is no content with the given ID.\n- An invalid operation or group is specified.\n- Given groupId is blank or has invalid characters","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content restrictions"],"summary":"Add group to content restriction","description":"Adds a group to a content restriction by Group Id. That is, grant read or update\npermission to the group for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"addGroupToContentRestrictionByGroupId","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"groupId","in":"path","description":"The groupId of the group to add to the content restriction.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the group is added to the content restriction by Group Id. The response\nbody will be empty.","content":{}},"400":{"description":"Returned if;\n- Group Id is not valid","content":{}},"403":{"description":"Returned if the calling user does not have permission to update the\ncontent.","content":{}},"404":{"description":"Returned if;\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or group id is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content restrictions"],"summary":"Remove group from content restriction","description":"Removes a group from a content restriction. That is, remove read or update\npermission for the group for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"removeGroupFromContentRestriction","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"name":"groupId","in":"path","description":"The id of the group to remove from the content restriction.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the group is removed from the content restriction. The response\nbody will be empty.","content":{}},"400":{"description":"Returned if given group id is blank","content":{}},"403":{"description":"Returned if the calling user does not have permission to view the content.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- The restriction to be deleted does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user":{"get":{"tags":["Content restrictions"],"summary":"Get content restriction status for user","description":"Returns whether the specified content restriction applies to a user.\nFor example, if a page with `id=123` has a `read` restriction for a user with an account ID of\n`384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following request will return `true`:\n\n`/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`\n\nNote that a response of `true` does not guarantee that the user can view the page, as it does not account for\naccount-inherited restrictions, space permissions, or even product access. For more\ninformation, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getContentRestrictionStatusForUser","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that is restricted.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"200":{"description":"Return true if the content restriction applies to the user. The response\nbody will be empty.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or user is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content restrictions"],"summary":"Add user to content restriction","description":"Adds a user to a content restriction. That is, grant read or update\npermission to the user for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"addUserToContentRestriction","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"200":{"description":"Returned if the user is added to the content restriction. The response\nbody will be empty.","content":{}},"400":{"description":"Returned if;\n\n- Provided restrictions are invalid","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or group is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content restrictions"],"summary":"Remove user from content restriction","description":"Removes a group from a content restriction. That is, remove read or update\npermission for the group for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"removeUserFromContentRestriction","parameters":[{"name":"id","in":"path","description":"The ID of the content that the restriction applies to.","required":true,"schema":{"type":"string"}},{"name":"operationKey","in":"path","description":"The operation that the restriction applies to.","required":true,"schema":{"type":"string","enum":["read","update"]}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"200":{"description":"Returned if the user is removed from the content restriction. The response\nbody will be empty.","content":{}},"404":{"description":"Returned if;\n\n- There is no content with the given ID.\n- The calling user does not have permission to view the content.\n- An invalid operation or group is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content.restriction:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/state":{"get":{"tags":["Content states"],"summary":"Get content state","description":"Gets the current content state of the draft or current version of content. To specify the draft version, set\nthe parameter status to draft, otherwise archived or current will get the relevant published state.\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content.","operationId":"getContentState","parameters":[{"name":"id","in":"path","description":"The id of the content whose content state is of interest.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Set status to one of [current,draft,archived]. Default value is current.","schema":{"type":"string","default":"current","enum":["current","draft","archived"]}}],"responses":{"200":{"description":"Returned if permission allows viewing of content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStateResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have content view permission."},"404":{"description":"Returned if the content with given id can not be found."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Content states"],"summary":"Set the content state of a content and publishes a new version of the content.","description":"Sets the content state of the content specified and creates a new version\n(publishes the content without changing the body) of the content with the new state.\n\nYou may pass in either an id of a state, or the name and color of a desired new state.\nIf all 3 are passed in, id will be used.\nIf the name and color passed in already exist under the current user's existing custom states, the existing state will be reused.\nIf custom states are disabled in the space of the content (which can be determined by getting the content state space settings of the content's space)\nthen this set will fail.\n\nYou may not remove a content state via this PUT request. You must use the DELETE method. A specified state is required in the body of this request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"setContentState","requestBody":{"description":"Content state fields for state. Pass in id for an existing state, or new name and color for best matching existing state, or new state if allowed in space.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStateRestInput"}}},"required":true},"parameters":[{"name":"id","in":"path","description":"The Id of the content whose content state is to be set.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of content onto which state will be placed. If draft, then draft state will change.\nIf current, state will be placed onto a new version of the content with same body as previous version.","schema":{"type":"string","enum":["current","draft"]}}],"responses":{"200":{"description":"Returned if content state is set successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStateResponse"}}}},"400":{"description":"Invalid Name/Color, non-existent id of content state, or type of state desired is not allowed.\nName must be less than or exactly 20 characters. Color must be a valid hex string.\nStatus must be in [draft,current]."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have content edit permission."},"404":{"description":"Returned if the content with given id can not be found."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content states"],"summary":"Removes the content state of a content and publishes a new version.","description":"Removes the content state of the content specified and creates a new version\n(publishes the content without changing the body) of the content with the new status.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"removeContentState","parameters":[{"name":"id","in":"path","description":"The Id of the content whose content state is to be set.","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","description":"status of content state from which to delete state. Can be draft or archived","schema":{"type":"string","enum":["current","draft"]}}],"responses":{"200":{"description":"Returned if content state is removed from content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStateResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have content edit permission."},"404":{"description":"Returned if the content with given id can not be found."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/state/available":{"get":{"tags":["Content states"],"summary":"Gets available content states for content.","description":"Gets content states that are available for the content to be set as.\nWill return all enabled Space Content States.\nWill only return most the 3 most recently published custom content states to match UI editor list.\nTo get all custom content states, use the /content-states endpoint.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the content.","operationId":"getAvailableContentStates","parameters":[{"name":"id","in":"path","description":"id of content to get available states for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the content is found and permission is valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableContentStates"}}}},"400":{"description":"Invalid status for content. Must be in [current,draft,archived]."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have content edit permission."},"404":{"description":"Returned if the content with given id can not be found."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content/{id}/version":{"get":{"tags":["Content versions"],"summary":"Get content versions","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns the versions for a piece of content in descending order.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content. If the content is a blog post, 'View' permission\nfor the space is required.","operationId":"getContentVersions","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its versions.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned versions.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of versions to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to expand. By default, the `content`\nobject is expanded.\n\n- `collaborators` returns the users that collaborated on the version.\n- `content` returns the content for the version.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the requested versions are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionArray"}}}},"403":{"description":"Returned if the calling user does not have permission to view the\ncontent.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Content versions"],"summary":"Restore content version","description":"Restores a historical version to be the latest version. That is, a new version\nis created with the content of the historical version.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"restoreContentVersion","parameters":[{"name":"id","in":"path","description":"The ID of the content for which the history will be restored.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to expand. By default, the `content`\nobject is expanded.\n\n- `collaborators` returns the users that collaborated on the version.\n- `content` returns the content for the version.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"description":"The content version to be restored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionRestore"}}},"required":true},"responses":{"200":{"description":"Returned if the version is restored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"400":{"description":"Returned if;\n\n- There is no content with the given ID.\n- There is no version with the given version number.\n- The version number is the current version.","content":{}},"403":{"description":"Returned if the calling user doesn't have permission to edit the\ncontent.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence","write:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content/{id}/version/{versionNumber}":{"get":{"tags":["Content versions"],"summary":"Get content version","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns a version for a piece of content.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content. If the content is a blog post, 'View' permission\nfor the space is required.","operationId":"getContentVersion","parameters":[{"name":"id","in":"path","description":"The ID of the content to be queried for its version.","required":true,"schema":{"type":"string"}},{"name":"versionNumber","in":"path","description":"The number of the version to be retrieved.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to expand. By default, the `content`\nobject is expanded.\n\n- `collaborators` returns the users that collaborated on the version.\n- `content` returns the content for the version.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the version is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"403":{"description":"Returned if the calling user does not have permission to view the\ncontent.","content":{}},"404":{"description":"Returned if the content or version cannot be found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Content versions"],"summary":"Delete content version","description":"Delete a historical version. This does not delete the changes made to the\ncontent in that version, rather the changes for the deleted version are\nrolled up into the next version. Note, you cannot delete the current version.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"deleteContentVersion","parameters":[{"name":"id","in":"path","description":"The ID of the content that the version will be deleted from.","required":true,"schema":{"type":"string"}},{"name":"versionNumber","in":"path","description":"The number of the version to be deleted. The version number starts\nfrom 1 up to current version.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Returned if the version is deleted.","content":{}},"400":{"description":"Returned if;\n\n- The content or version cannot be found.\n- The current version is specified.","content":{}},"403":{"description":"Returned if the calling user doesn't have permission to edit the\ncontent.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["delete:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/content-states":{"put":{"tags":["Content states"],"summary":"Bulk set content state of many contents","deprecated":true,"description":"Creates a long running task that sets content state of draft or published versions of pages specified.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**\nContent Edit Permission for a content to have its state set via this endpoint.","operationId":"bulkSetContentStates","parameters":[{"name":"status","in":"query","required":true,"description":"Set status to one of [current,draft].","schema":{"type":"string","enum":["current","draft"]}}],"requestBody":{"description":"The content state and ids to set it to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkContentStateSetInput"}}},"required":true},"responses":{"200":{"description":"Returned if a task to set content states is created. Returns the taskId.\nThis task id can be passed into /wiki/rest/api/content-states/task/{taskId} for a result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncId"}}}},"400":{"description":"Returned if too many contents, no contents, no content state, or no status are passed in."},"404":{"description":"Returned if content cannot be found with the provided context."}},"security":[{"oAuthDefinitions":["write:confluence-content"]},{"basicAuth":[]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"get":{"tags":["Content states"],"summary":"Get Custom Content States","description":"Get custom content states that authenticated user has created.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**\nMust have user authentication.","operationId":"getCustomContentStates","responses":{"200":{"description":"Custom Content States that user has crated. Returned if user authenticated.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentState"}}}}},"401":{"description":"Returned if user is not authenticated."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:user.property:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:user.property:confluence"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:user.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/content-states/delete":{"post":{"tags":["Content states"],"summary":"Bulk remove content states from content","description":"Creates a long running task that Removes content state from draft or published versions of pages specified.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**\nContent Edit Permission for a content to have its state removed via this endpoint.","operationId":"bulkRemoveContentStates","parameters":[{"name":"status","in":"query","required":true,"description":"Set status to one of [current,draft].","schema":{"type":"string","enum":["current","draft"]}}],"requestBody":{"content":{"application/json":{"schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"$ref":"#/components/schemas/ContentId"}}}}}}},"responses":{"200":{"description":"Returned if a task to remove content states is created. Returns the taskId.\nThis task id can be passed into /wiki/rest/api/content-states/task/{taskId}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncId"}}}},"400":{"description":"Returned if too many contents, no contents, no content state, or no status are passed in."},"401":{"description":"Returned if user not authenticated."},"403":{"description":"Returned if user not found or does not have permission for content stat"},"404":{"description":"Returned if content cannot be found with the provided context."}},"security":[{"oAuthDefinitions":["write:confluence-content"]},{"basicAuth":[]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:content:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/content-states/task/{taskId}":{"get":{"tags":["Content states"],"summary":"Get update on long running task for setting of content state.","description":"Get Status of long running task that was previously created to set or remove content states from content.\nUser must first create a task by passing in details to /wiki/rest/api/content-states PUT or DELETE endpoints.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**\nMust have created long running task","operationId":"getTaskUpdate","parameters":[{"name":"taskId","in":"path","schema":{"type":"string"},"description":"taskId returned by put or delete requests to /wiki/rest/api/content-states","required":true}],"responses":{"200":{"description":"Task found. State of task is returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStateBulkSetTaskUpdate"}}}},"403":{"description":"User not authenticated."},"404":{"description":"No long running task by calling user with given taskId found."}},"security":[{"oAuthDefinitions":["read:confluence-content"]},{"basicAuth":[]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/contentbody/convert/{to}":{"post":{"tags":["Content body"],"summary":"Convert content body","description":"Converts a content body from one format to another format.\n\nSupported conversions:\n\n- storage: view, export_view, styled_view, editor\n- editor: storage\n- view: none\n- export_view: none\n- styled_view: none\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nIf request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.","operationId":"convertContentBody","parameters":[{"name":"to","in":"path","description":"The name of the target format for the content body.","required":true,"schema":{"type":"string"}},{"name":"spaceKeyContext","in":"query","description":"The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link ``\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space.","schema":{"type":"string"}},{"name":"contentIdContext","in":"query","description":"The content ID used to find the space for resolving embedded content\n(page includes, files, and links) in the content body. For example,\nif the source content contains the link ``\nand the `contentIdContext=123` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the same space\nthat has the content with ID=123. Note, `spaceKeyContext` will be ignored\nif this parameter is provided.","schema":{"type":"string"}},{"name":"embeddedContentRender","in":"query","description":"Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save.","schema":{"type":"string","default":"current","enum":["current","version-at-save"]}},{"$ref":"#/components/parameters/bodyConversionExpand"}],"requestBody":{"description":"The content body to convert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentBodyCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the content is converted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentBody"}}}},"400":{"description":"Returned if the content body is invalid or if the value is improperly formed.","content":{}},"404":{"description":"Returned if content cannot be found with the provided context.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/contentbody/convert/async/{to}":{"post":{"tags":["Content body"],"summary":"Asynchronously convert content body","description":"Converts a content body from one format to another format asynchronously.\nReturns the asyncId for the asynchronous task.\n\nSupported conversions:\n\n- storage: export_view\n\nNo other conversions are supported at the moment.\nOnce a conversion is completed, it will be available for 5 minutes at the result endpoint.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nIf request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.","operationId":"asyncConvertContentBodyRequest","parameters":[{"name":"to","in":"path","description":"The name of the target format for the content body.","required":true,"schema":{"type":"string","enum":["export_view"]}},{"$ref":"#/components/parameters/bodyConversionExpand"},{"name":"spaceKeyContext","in":"query","description":"The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link ``\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space.","schema":{"type":"string"}},{"name":"contentIdContext","in":"query","description":"The content ID used to find the space for resolving embedded content\n(page includes, files, and links) in the content body. For example,\nif the source content contains the link ``\nand the `contentIdContext=123` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the same space\nthat has the content with ID=123. Note, `spaceKeyContext` will be ignored\nif this parameter is provided.","schema":{"type":"string"}},{"name":"allowCache","in":"query","description":"If this field is false, the cache will erase its current value and begin a new conversion.\nIf this field is true, the cache will not erase its current value, and will set the status of the\nasync conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. \nLarge macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes)\nshould set this fields to true. Cache values are stored per user per content body and expansions.","schema":{"type":"boolean","default":false}},{"name":"embeddedContentRender","in":"query","description":"Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save.","schema":{"type":"string","default":"current","enum":["current","version-at-save"]}}],"requestBody":{"description":"The content body to convert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentBodyCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the content is added to the messaging queue for conversion. This id will be available for 5 minutes after the conversion is complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncId"}}}},"400":{"description":"Returned\n- if the content body or conversion context is invalid or null\n- if the value is improperly formed\n- any conversion type other than export_view","content":{}},"404":{"description":"Returned if content cannot be found with the provided context.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/contentbody/convert/async/{id}":{"get":{"tags":["Content body"],"summary":"Get asynchronously converted content body from the id or the current status of the task.","description":"Returns the asynchronous content body for the corresponding id if the task is complete \nor returns the status of the task.\n\nAfter the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is made again,\nwith allowCache query param set to false.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nIf request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content.","operationId":"asyncConvertContentBodyResponse","parameters":[{"name":"id","in":"path","description":"The asyncId of the macro task to get the converted body.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if successfully found an async conversion task associated with the id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncContentBody"}}}},"400":{"description":"Returned if the async id is invalid.","content":{}},"401":{"description":"Returned if the request was not made by an anonymous user and user is not authenticated.","content":{}},"403":{"description":"Returned if the requesting user is not the user who made the conversion request.","content":{}},"404":{"description":"Returned if async macro conversion task cannot be found with the provided id.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/inlinetasks/search":{"get":{"tags":["Inline tasks"],"summary":"Get inline tasks based on search parameters","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns inline tasks based on the search query.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission). Only tasks\nin contents that the user has permission to view are returned.","operationId":"searchTasks","parameters":[{"name":"start","in":"query","description":"The starting offset for the results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The number of results to be returned.","schema":{"type":"integer","format":"int32","default":20}},{"name":"spaceKey","in":"query","description":"The space key of a space. Multiple space keys can be specified.","schema":{"type":"string","default":null}},{"name":"pageId","in":"query","description":"The page id of a page. Multiple page ids can be specified.","schema":{"type":"string","default":null}},{"name":"assignee","in":"query","description":"Account ID of a user to whom a task is assigned. Multiple users can be specified.","schema":{"type":"string","default":null}},{"name":"creator","in":"query","description":"Account ID of a user to who created a task. Multiple users can be specified.","schema":{"type":"string","default":null}},{"name":"completedUser","in":"query","description":"Account ID of a user who completed a task. Multiple users can be specified.","schema":{"type":"string","default":null}},{"name":"duedateFrom","in":"query","description":"Start of date range based on due dates (inclusive).","schema":{"type":"integer","format":"int64"}},{"name":"duedateTo","in":"query","description":"End of date range based on due dates (inclusive).","schema":{"type":"integer","format":"int64"}},{"name":"createdateFrom","in":"query","description":"Start of date range based on create dates (inclusive).","schema":{"type":"integer","format":"int64"}},{"name":"createdateTo","in":"query","description":"End of date range based on create dates (inclusive).","schema":{"type":"integer","format":"int64"}},{"name":"completedateFrom","in":"query","description":"Start of date range based on complete dates (inclusive).","schema":{"type":"integer","format":"int64"}},{"name":"completedateTo","in":"query","description":"End of date range based on complete dates (inclusive).","schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","description":"The status of the task. (checked/unchecked)","schema":{"type":"string","default":null,"enum":["complete","incomplete"]}}],"responses":{"200":{"description":"Returned if the query fetches zero or more results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskPageResponse"}}}},"403":{"description":"Returned if the calling user does not have permission to view\nany content.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.all"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:inlinetask:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/inlinetasks/{inlineTaskId}":{"get":{"tags":["Inline tasks"],"summary":"Get inline task based on global ID","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns inline task based on the global ID.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the content associated with the task.","operationId":"getTaskById","parameters":[{"name":"inlineTaskId","in":"path","description":"Global ID of the inline task","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the inline task was found given the global ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if the user does not have permission to view the content associated with the task."},"404":{"description":"Returned if task could not be found with the given global ID."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:inlinetask:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:inlinetask:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Inline tasks"],"summary":"Update inline task given global ID","deprecated":true,"description":"Updates an inline tasks status given its global ID\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content associated with the task.","operationId":"updateTaskById","parameters":[{"name":"inlineTaskId","in":"path","description":"Global ID of the inline task to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The updated task status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskStatusUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the inline task was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":"Returned if client input is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if the user does not have permission to update the content associated with the task."},"404":{"description":"Returned if task could not be found with given global ID."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:inlinetask:confluence","write:inlinetask:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:inlinetask:confluence","write:inlinetask:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/label":{"get":{"tags":["Label info"],"summary":"Get label information","description":"Returns label information and a list of contents associated with the label.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission). Only contents\nthat the user is permitted to view is returned.","operationId":"getAllLabelContent","parameters":[{"name":"name","in":"query","description":"Name of the label to query.","required":true,"schema":{"type":"string","default":null}},{"name":"type","in":"query","description":"The type of contents that are to be returned.","schema":{"type":"string","default":null,"enum":["page","blogpost","attachment","page_template"]}},{"name":"start","in":"query","description":"The starting offset for the results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The number of results to be returned.","schema":{"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the query fetches zero or more results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelDetails"}}}},"400":{"description":"Returned if no label name is provide or\nif content type provided in the query is invalid.","content":{}},"403":{"description":"Returned if the calling user does not have permission to view\nany content including label info.","content":{}},"404":{"description":"Returned if the lable name is invalid or if no label is found for a given label.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:label:confluence","read:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group":{"get":{"tags":["Group"],"summary":"Get groups","description":"Returns all user groups. The returned groups are ordered alphabetically in\nascending order by group name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroups","parameters":[{"name":"start","in":"query","description":"The starting index of the returned groups.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of groups to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}},{"name":"accessType","in":"query","description":"The group permission level for which to filter results.","required":false,"schema":{"type":"string","default":null,"enum":["user","admin","site-admin"]}}],"responses":{"200":{"description":"Returned if the requested groups are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupArrayWithLinks"}}}},"403":{"description":"Returned if the calling user does not have permission to view\ngroups.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Group"],"summary":"Create new user group","description":"Creates a new user group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"createGroup","requestBody":{"description":"Name of the group that is to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupName"}}},"required":true},"responses":{"201":{"description":"Returned if the group was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Returned if the name is missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence","write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Group"],"summary":"Delete user group","description":"Delete user group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"removeGroup","parameters":[{"name":"name","in":"query","description":"Name of the group to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the group was removed successfully.","content":{}},"400":{"description":"Returned if the name is missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.","content":{}},"404":{"description":"If no user group by the give name exists.","content":{}}},"deprecated":true,"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/group/by-name":{"get":{"tags":["Group"],"summary":"Get group","description":"Returns a user group for a given group name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroupByQueryParam","parameters":[{"name":"name","in":"query","description":"The name of the group. This is the same as the group name shown in\nthe Confluence administration console.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested group is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"403":{"description":"Returned if the calling user does not have permission to view\ngroups.","content":{}},"404":{"description":"Returned if the group does not exist.","content":{}}},"deprecated":true,"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group/by-id":{"get":{"tags":["Group"],"summary":"Get group","description":"Returns a user group for a given group id.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroupByGroupId","parameters":[{"name":"id","in":"query","description":"The id of the group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested group is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"403":{"description":"Returned if the calling user does not have permission to view\ngroups.","content":{}},"404":{"description":"Returned if the group does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Group"],"summary":"Delete user group","description":"Delete user group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"removeGroupById","parameters":[{"name":"id","in":"query","description":"Id of the group to delete.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the group was removed successfully.","content":{}},"400":{"description":"Returned if the id is missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.","content":{}},"404":{"description":"If no user group by the given id exists.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/group/{groupName}":{"get":{"tags":["Group"],"summary":"Get group","description":"Returns a user group for a given group name.\n\nUse updated Get group API\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroupByName","parameters":[{"name":"groupName","in":"path","description":"The name of the group. This is the same as the group name shown in\nthe Confluence administration console.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested group is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"403":{"description":"Returned if the calling user does not have permission to view\ngroups.","content":{}},"404":{"description":"Returned if the group does not exist.","content":{}}},"deprecated":true,"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group/member":{"get":{"tags":["Group"],"summary":"Get group members","description":"Returns the users that are members of a group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getMembersByQueryParam","parameters":[{"name":"name","in":"query","description":"The name of the group to be queried for its members.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned users.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of users to return per page.\nNote, this is restricted by fixed system limit of 200 which is to say if the limit parameter\nexceeds 200, this API will return a maximum of 200 users per page.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}},{"name":"shouldReturnTotalSize","in":"query","description":"Whether to include total size parameter in the results.\nNote, fetching total size property is an expensive operation; use it if your use case needs this value.","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["operations","personalSpace","isExternalCollaborator"]}}}],"responses":{"200":{"description":"Returned if the requested users are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserArray"}}}},"403":{"description":"Returned if the calling user does not have permission to view users.","content":{}}},"deprecated":true,"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence","read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group/{groupName}/member":{"get":{"tags":["Group"],"summary":"Get group members","description":"Returns the users that are members of a group.\n\nUse updated Get group API\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroupMembers","parameters":[{"name":"groupName","in":"path","description":"The name of the group to be queried for its members.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned users.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of users to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the requested users are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserArray"}}}},"400":{"description":"Returned if given limit is greater than 200","content":{}},"403":{"description":"Returned if the calling user does not have permission to view users.","content":{}}},"deprecated":true,"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group/picker":{"get":{"tags":["Group"],"summary":"Search groups by partial query","description":"Get search results of groups by partial query provided.","operationId":"searchGroups","parameters":[{"name":"query","in":"query","description":"the search term used to query results.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned groups.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of groups to return per page.\nNote, this is restricted to a maximum limit of 200 groups.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}},{"name":"shouldReturnTotalSize","in":"query","description":"Whether to include total size parameter in the results.\nNote, fetching total size property is an expensive operation; use it if your use case needs this value.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returns a full JSON representation of group collection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupArrayWithLinks"}}}},"403":{"description":"Returned if the calling user does not have permission to view\ngroups.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group/userByGroupId":{"post":{"tags":["Group"],"summary":"Add member to group by groupId","description":"Adds a user as a member in a group represented by its groupId\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"addUserToGroupByGroupId","parameters":[{"name":"groupId","in":"query","description":"GroupId of the group whose membership is updated","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"AccountId of the user who needs to be added as member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountId"}}},"required":true},"responses":{"201":{"description":"Returned if the group was created successfully.","content":{}},"400":{"description":"Returned if the groupId or accountId are missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.","content":{}},"404":{"description":"If no user group by the give name exists.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Group"],"summary":"Remove member from group using group id","description":"Remove user as a member from a group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"removeMemberFromGroupByGroupId","parameters":[{"name":"groupId","in":"query","description":"Id of the group whose membership is updated.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the group was removed successfully.","content":{}},"400":{"description":"Returned if the name is missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.\nNote: A 204 is returned if the user is not part of the\ngroup.","content":{}},"404":{"description":"If no user group by the give name exists or if no user exists\nfor the given accountId.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/group/{groupId}/membersByGroupId":{"get":{"tags":["Group"],"summary":"Get group members","description":"Returns the users that are members of a group.\n\nUse updated Get group API\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroupMembersByGroupId","parameters":[{"name":"groupId","in":"path","description":"The id of the group to be queried for its members.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned users.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of users to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}},{"name":"shouldReturnTotalSize","in":"query","description":"Whether to include total size parameter in the results.\nNote, fetching total size property is an expensive operation; use it if your use case needs this value.","schema":{"type":"boolean","default":false}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["operations","personalSpace","isExternalCollaborator"]}}}],"responses":{"200":{"description":"Returned if the requested users are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserArray"}}}},"400":{"description":"Returned if given limit is greater than 200","content":{}},"403":{"description":"Returned if the calling user does not have permission to view users.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:group:confluence","read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/group/user":{"post":{"tags":["Group"],"summary":"Add member to group","description":"Adds a user as a member in a group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"addUserToGroup","parameters":[{"name":"name","in":"query","description":"Name of the group whose membership is updated","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"AccountId of the user who needs to be added as member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountId"}}},"required":true},"responses":{"201":{"description":"Returned if the group was created successfully.","content":{}},"400":{"description":"Returned if the name or accountId are missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.","content":{}},"404":{"description":"If no user group by the give name exists.","content":{}}},"deprecated":true,"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Group"],"summary":"Remove member from group","description":"Remove user as a member from a group.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nUser must be a site admin.","operationId":"removeMemberFromGroup","parameters":[{"name":"name","in":"query","description":"Name of the group whose membership is updated.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the group was removed successfully.","content":{}},"400":{"description":"Returned if the name is missing or invalid.","content":{}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"403":{"description":"Returned if the user is not a site admin.\nNote: A 204 is returned if the user is not part of the\ngroup.","content":{}},"404":{"description":"If no user group by the give name exists or if no user exists\nfor the given accountId.","content":{}}},"deprecated":true,"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-groups"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-groups"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/longtask":{"get":{"tags":["Long-running task"],"summary":"Get long-running tasks","description":"Returns information about all active long-running tasks (e.g. space export),\nsuch as how long each task has been running and the percentage of each task\nthat has completed.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getTasks","parameters":[{"name":"start","in":"query","description":"The starting index of the returned tasks.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of tasks to return per page. Note, this may be\nrestricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the requested tasks are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongTaskStatusArray"}}}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:content.metadata:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/longtask/{id}":{"get":{"tags":["Long-running task"],"summary":"Get long-running task","description":"Returns information about an active long-running task (e.g. space export),\nsuch as how long it has been running and the percentage of the task that\nhas completed.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getTask","parameters":[{"name":"id","in":"path","description":"The ID of the task.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested task is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongTaskStatusWithLinks"}}}},"401":{"description":"Returned if the calling user is not logged in to Confluence.","content":{}},"404":{"description":"Returned if;\n\n- There is no task with the given ID.\n- The calling user does not have permission to view the task.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}":{"get":{"tags":["Relation"],"summary":"Find target entities related to a source entity","description":"Returns all target entities that have a particular relationship to the\nsource entity. Note, relationships are one way.\n\nFor example, the following method finds all content that the current user\nhas an 'ignore' relationship with:\n`GET /wiki/rest/api/relation/ignore/from/user/current/to/content`\nNote, 'ignore' is an example custom relationship type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view both the target entity and source entity.","operationId":"findTargetFromSource","parameters":[{"name":"relationName","in":"path","description":"The name of the relationship. This method supports relationships created via\n[Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).\nNote, this method does not support 'like' or 'favourite' relationships.","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"path","description":"The source entity type of the relationship.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"sourceKey","in":"path","description":"The identifier for the source entity:\n\n- If `sourceType` is `user`, then specify either `current` (logged-in user), the user key of the user, or\nthe account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"targetType","in":"path","description":"The target entity type of the relationship.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"sourceStatus","in":"query","description":"The status of the source. This parameter is only used when the\n`sourceType` is 'content'.","schema":{"type":"string"}},{"name":"targetStatus","in":"query","description":"The status of the target. This parameter is only used when the\n`targetType` is 'content'.","schema":{"type":"string"}},{"name":"sourceVersion","in":"query","description":"The version of the source. This parameter is only used when the\n`sourceType` is 'content' and the `sourceStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"targetVersion","in":"query","description":"The version of the target. This parameter is only used when the\n`targetType` is 'content' and the `targetStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the response\nobject to expand.\n\n- `relationData` returns information about the relationship, such as\nwho created it and when it was created.\n- `source` returns the source entity.\n- `target` returns the target entity.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["relationData","source","target"]}}},{"name":"start","in":"query","description":"The starting index of the returned relationships.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of relationships to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested relationships are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationArray"}}}},"400":{"description":"Returned if the request is invalid.","content":{}},"403":{"description":"Returned if the user does not have permission to view the\nrelationships.","content":{}},"404":{"description":"Returned if the target entity does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:relation:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}":{"get":{"tags":["Relation"],"summary":"Find relationship from source to target","description":"Find whether a particular type of relationship exists from a source\nentity to a target entity. Note, relationships are one way.\n\nFor example, you can use this method to find whether the current user has\nselected a particular page as a favorite (i.e. 'save for later'):\n`GET /wiki/rest/api/relation/favourite/from/user/current/to/content/123`\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view both the target entity and source entity.","operationId":"getRelationship","parameters":[{"name":"relationName","in":"path","description":"The name of the relationship. This method supports the 'favourite'\n(i.e. 'save for later') relationship as well as any other relationship\ntypes created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"path","description":"The source entity type of the relationship. This must be 'user', if\nthe `relationName` is 'favourite'.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"sourceKey","in":"path","description":"- The identifier for the source entity:\n\n- If `sourceType` is `user`, then specify either `current` (logged-in user), the user key of the user, or\nthe account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"targetType","in":"path","description":"The target entity type of the relationship. This must be 'space' or\n'content', if the `relationName` is 'favourite'.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"targetKey","in":"path","description":"The identifier for the target entity:\n\n- If `targetType` is `user`, then specify either `current` (logged-in user), the user key of the user, or\nthe account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n- If `targetType` is 'content', then specify the content ID.\n- If `targetType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"sourceStatus","in":"query","description":"The status of the source. This parameter is only used when the\n`sourceType` is 'content'.","schema":{"type":"string"}},{"name":"targetStatus","in":"query","description":"The status of the target. This parameter is only used when the\n`targetType` is 'content'.","schema":{"type":"string"}},{"name":"sourceVersion","in":"query","description":"The version of the source. This parameter is only used when the\n`sourceType` is 'content' and the `sourceStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"targetVersion","in":"query","description":"The version of the target. This parameter is only used when the\n`targetType` is 'content' and the `targetStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the response\nobject to expand.\n\n- `relationData` returns information about the relationship, such as\nwho created it and when it was created.\n- `source` returns the source entity.\n- `target` returns the target entity.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["relationData","source","target"]}}}],"responses":{"200":{"description":"Returned if the relationship exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Relation"}}}},"400":{"description":"Returned if the request is invalid.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user does not have permission to view the\nrelationship.","content":{}},"404":{"description":"Returned if the relationship does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:relation:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Relation"],"summary":"Create relationship","description":"Creates a relationship between two entities (user, space, content). The\n'favourite' relationship is supported by default, but you can use this method\nto create any type of relationship between two entities.\n\nFor example, the following method creates a 'sibling' relationship between\ntwo pieces of content:\n`PUT /wiki/rest/api/relation/sibling/from/content/123/to/content/456`\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"createRelationship","parameters":[{"name":"relationName","in":"path","description":"The name of the relationship. This method supports the 'favourite'\n(i.e. 'save for later') relationship. You can also specify any other\nvalue for this parameter to create a custom relationship type.","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"path","description":"The source entity type of the relationship. This must be 'user', if\nthe `relationName` is 'favourite'.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"sourceKey","in":"path","description":"- The identifier for the source entity:\n\n- If `sourceType` is 'user', then specify either 'current' (logged-in\n user) or the user key.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"targetType","in":"path","description":"The target entity type of the relationship. This must be 'space' or\n'content', if the `relationName` is 'favourite'.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"targetKey","in":"path","description":"- The identifier for the target entity:\n\n- If `sourceType` is 'user', then specify either 'current' (logged-in\n user) or the user key.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"sourceStatus","in":"query","description":"The status of the source. This parameter is only used when the\n`sourceType` is 'content'.","schema":{"type":"string"}},{"name":"targetStatus","in":"query","description":"The status of the target. This parameter is only used when the\n`targetType` is 'content'.","schema":{"type":"string"}},{"name":"sourceVersion","in":"query","description":"The version of the source. This parameter is only used when the\n`sourceType` is 'content' and the `sourceStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"targetVersion","in":"query","description":"The version of the target. This parameter is only used when the\n`targetType` is 'content' and the `targetStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the relationship is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Relation"}}}},"400":{"description":"Returned if the request is invalid.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user does not have permission to use Confluence.","content":{}},"404":{"description":"Returned if the user, space or content could not be found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:relation:confluence","read:space:confluence","read:user:confluence","read:content:confluence","write:relation:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Relation"],"summary":"Delete relationship","description":"Deletes a relationship between two entities (user, space, content).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).\nFor favourite relationships, the current user can only delete their own\nfavourite relationships. A space administrator can delete favourite\nrelationships for any user.","operationId":"deleteRelationship","parameters":[{"name":"relationName","in":"path","description":"The name of the relationship.","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"path","description":"The source entity type of the relationship. This must be 'user', if\nthe `relationName` is 'favourite'.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"sourceKey","in":"path","description":"- The identifier for the source entity:\n\n- If `sourceType` is 'user', then specify either 'current' (logged-in\n user) or the user key.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"targetType","in":"path","description":"The target entity type of the relationship. This must be 'space' or\n'content', if the `relationName` is 'favourite'.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"targetKey","in":"path","description":"- The identifier for the target entity:\n\n- If `sourceType` is 'user', then specify either 'current' (logged-in\n user) or the user key.\n- If `sourceType` is 'content', then specify the content ID.\n- If `sourceType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"sourceStatus","in":"query","description":"The status of the source. This parameter is only used when the\n`sourceType` is 'content'.","schema":{"type":"string"}},{"name":"targetStatus","in":"query","description":"The status of the target. This parameter is only used when the\n`targetType` is 'content'.","schema":{"type":"string"}},{"name":"sourceVersion","in":"query","description":"The version of the source. This parameter is only used when the\n`sourceType` is 'content' and the `sourceStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"targetVersion","in":"query","description":"The version of the target. This parameter is only used when the\n`targetType` is 'content' and the `targetStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Returned if the relationship is deleted or the relationship didn't\nexist.","content":{}},"400":{"description":"Returned if the request is invalid.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user does not have permission to delete the\nrelationship.","content":{}},"404":{"description":"Returned if the user, space or content could not be found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:relation:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}":{"get":{"tags":["Relation"],"summary":"Find source entities related to a target entity","description":"Returns all target entities that have a particular relationship to the\nsource entity. Note, relationships are one way.\n\nFor example, the following method finds all users that have a 'collaborator'\nrelationship to a piece of content with an ID of '1234':\n`GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user`\nNote, 'collaborator' is an example custom relationship type.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view both the target entity and source entity.","operationId":"findSourcesForTarget","parameters":[{"name":"relationName","in":"path","description":"The name of the relationship. This method supports relationships created via\n[Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).\nNote, this method does not support 'like' or 'favourite' relationships.","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"path","description":"The source entity type of the relationship.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"targetType","in":"path","description":"The target entity type of the relationship.","required":true,"schema":{"type":"string","enum":["user","content","space"]}},{"name":"targetKey","in":"path","description":"The identifier for the target entity:\n\n- If `targetType` is `user`, then specify either `current` (logged-in user), the user key of the user, or\nthe account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n- If `targetType` is 'content', then specify the content ID.\n- If `targetType` is 'space', then specify the space key.","required":true,"schema":{"type":"string"}},{"name":"sourceStatus","in":"query","description":"The status of the source. This parameter is only used when the\n`sourceType` is 'content'.","schema":{"type":"string"}},{"name":"targetStatus","in":"query","description":"The status of the target. This parameter is only used when the\n`targetType` is 'content'.","schema":{"type":"string"}},{"name":"sourceVersion","in":"query","description":"The version of the source. This parameter is only used when the\n`sourceType` is 'content' and the `sourceStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"targetVersion","in":"query","description":"The version of the target. This parameter is only used when the\n`targetType` is 'content' and the `targetStatus` is 'historical'.","schema":{"type":"integer","format":"int32"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the response\nobject to expand.\n\n- `relationData` returns information about the relationship, such as\nwho created it and when it was created.\n- `source` returns the source entity.\n- `target` returns the target entity.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["relationData","source","target"]}}},{"name":"start","in":"query","description":"The starting index of the returned relationships.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of relationships to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested relationships are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationArray"}}}},"400":{"description":"Returned if the request is invalid.","content":{}},"403":{"description":"Returned if the user does not have permission to view the\nrelationship","content":{}},"404":{"description":"Returned if the target entity does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:relation:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/search":{"get":{"tags":["Search"],"summary":"Search content","description":"Searches for content using the\n[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).\n\n**Note that CQL input queries submitted through the `/wiki/rest/api/search` endpoint no longer support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.** \nSee this [deprecation notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/) for more details.\n\nExample initial call:\n```\n/wiki/rest/api/search?cql=type=page&limit=25\n```\n\nExample response:\n```\n{\n \"results\": [\n { ... },\n { ... },\n ...\n { ... }\n ],\n \"limit\": 25,\n \"size\": 25,\n ...\n \"_links\": {\n \"base\": \"\",\n \"context\": \"\",\n \"next\": \"/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg\",\n \"self\": \"\"\n }\n}\n```\n\nWhen additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of results returned in each call.\n\nExample subsequent call (taken from example response):\n```\n/wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg\n```\nThe response to this will have a `prev` URL similar to the `next` in the example response.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the entities. Note, only entities that the user has\npermission to view will be returned.","operationId":"searchByCQL","parameters":[{"name":"cql","in":"query","description":"The CQL query to be used for the search. See\n[Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)\nfor instructions on how to build a CQL query.","required":true,"schema":{"type":"string"}},{"name":"cqlcontext","in":"query","description":"The space, content, and content status to execute the search\nagainst.\n\n- `spaceKey` Key of the space to search against. Optional.\n- `contentId` ID of the content to search against. Optional. Must be\nin the space specified by `spaceKey`.\n- `contentStatuses` Content statuses to search against. Optional.\n\nSpecify these values in an object. For example,\n`cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.","schema":{"type":"string"}},{"name":"next","in":"query","schema":{"type":"boolean","default":false}},{"name":"prev","in":"query","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","description":"The maximum number of content objects to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}},{"name":"start","in":"query","description":"The start point of the collection to return","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"includeArchivedSpaces","in":"query","description":"Whether to include content from archived spaces in the results.","schema":{"type":"boolean","default":false}},{"name":"excludeCurrentSpaces","in":"query","description":"Whether to exclude current spaces and only show archived spaces.","schema":{"type":"boolean","default":false}},{"name":"excerpt","in":"query","description":"The excerpt strategy to apply to the result","schema":{"type":"string","default":"highlight","enum":["highlight","indexed","none","highlight_unescaped","indexed_unescaped"]}},{"name":"sitePermissionTypeFilter","in":"query","description":"Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`\nfor external/guest users, and `all` to include all permission types.","schema":{"type":"string","default":"none","enum":["all","externalCollaborator","none"]}},{"name":"_","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"expand","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the requested results are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPageResponseSearchResult"}}}},"400":{"description":"Returned if the CQL query cannot be parsed.","content":{}},"403":{"description":"Returned if the calling user does not have permission to access\nConfluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["search:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["search:confluence"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/search/user":{"get":{"tags":["Search"],"summary":"Search users","description":"Searches for users using user-specific queries from the\n[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).\n\nNote that CQL input queries submitted through the `/wiki/rest/api/search/user` endpoint only support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.\n\nNote that some user fields may be set to null depending on the user's privacy settings.\nThese are: email, profilePicture, displayName, and timeZone.","operationId":"searchUser","parameters":[{"name":"cql","in":"query","description":"The CQL query to be used for the search. See\n[Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)\nfor instructions on how to build a CQL query.\n\nExample queries:\n cql=type=user will return all users\n cql=user=\"1234\" will return user with accountId \"1234\"\n You can also use IN, NOT IN, != operators\n cql=user IN (\"12\", \"34\") will return users with accountids \"12\" and \"34\"\n cql=user.fullname~jo will return users with nickname/full name starting with \"jo\"\n cql=user.accountid=\"123\" will return user with accountId \"123\"","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned users.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of user objects to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to expand.\n\n- `operations` returns the operations for the user, which are used\nwhen setting permissions.\n- `personalSpace` returns the personal space of the user.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sitePermissionTypeFilter","in":"query","description":"Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`\nfor external/guest users, and `all` to include all permission types.","schema":{"type":"string","default":"none","enum":["all","externalCollaborator","none"]}}],"responses":{"200":{"description":"Returned if the requested results are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPageResponseSearchResult"}}}},"400":{"description":"Returned if the CQL query cannot be parsed.","content":{}},"403":{"description":"Returned if the calling user does not have permission to access\nConfluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:content-details:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/settings/lookandfeel":{"get":{"tags":["Settings"],"summary":"Get look and feel settings","description":"Returns the look and feel settings for the site or a single space. This\nincludes attributes such as the color scheme, padding, and border radius.\n\nThe look and feel settings for a space can be inherited from the global\nlook and feel settings or provided by a theme.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nNone","operationId":"getLookAndFeelSettings","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space for which the look and feel settings will be\nreturned. If this is not set, only the global look and feel settings\nare returned.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested look and feel settings are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookAndFeelSettings"}}}},"400":{"description":"Returned if `spaceKey` is invalid.","content":{}},"404":{"description":"Returned if there is no space with the given `spaceKey`.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence","read:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Settings"],"summary":"Select look and feel settings","description":"Sets the look and feel settings to the default (global) settings, the\ncustom settings, or the current theme's settings for a space.\nThe custom and theme settings can only be selected if there is already\na theme set for a space. Note, the default space settings are inherited\nfrom the current global settings.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"updateLookAndFeel","requestBody":{"description":"The look and feel type to be set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookAndFeelSelection"}}},"required":true},"responses":{"200":{"description":"Returned if the look and feel settings were set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookAndFeelSelection"}}}},"400":{"description":"Returned if;\n\n- `spaceKey` is invalid.\n- `lookAndFeelType` is invalid.","content":{}},"403":{"description":"Returned if the calling user doesn't have permission to edit the\nlook and feel settings.","content":{}},"404":{"description":"Returned if there is no space with the given `spaceKey`.","content":{}},"409":{"description":"Returned if `lookAndFeelType` is set to 'custom' or 'theme',\nand a theme is not currently set for the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence","write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/settings/lookandfeel/custom":{"post":{"tags":["Settings"],"summary":"Update look and feel settings","description":"Updates the look and feel settings for the site or for a single space.\nIf custom settings exist, they are updated. If no custom settings exist,\nthen a set of custom settings is created.\n\nNote, if a theme is selected for a space, the space look and feel settings\nare provided by the theme and cannot be overridden.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"updateLookAndFeelSettings","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space for which the look and feel settings will be\nupdated. If this is not set, the global look and feel settings will\nbe updated.","schema":{"type":"string"}}],"requestBody":{"description":"The updated settings. All values for the settings must be included,\nregardless of whether they are being changed.\n\nOne way to create the request body is to copy the settings from the\nresponse body of [Get look and feel settings](#api-settings-lookandfeel-get)\nand modify it as needed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookAndFeel"}}},"required":true},"responses":{"200":{"description":"Returned if the look and feel settings are updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookAndFeelWithLinks"}}}},"400":{"description":"Returned if;\n\n- The `spaceKey` is invalid\n- The request body contains invalid data.","content":{}},"403":{"description":"Returned if the calling user doesn't have permission to edit the\nlook and feel settings.","content":{}},"404":{"description":"Returned if there is no space with the given `spaceKey`.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence","read:space.setting:confluence","write:configuration:confluence","write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Settings"],"summary":"Reset look and feel settings","description":"Resets the custom look and feel settings for the site or a single space.\nThis changes the values of the custom settings to be the same as the\ndefault settings. It does not change which settings (default or custom)\nare selected. Note, the default space settings are inherited from the\ncurrent global settings.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"resetLookAndFeelSettings","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space for which the look and feel settings will be\nreset. If this is not set, the global look and feel settings will\nbe reset.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the look and feel settings have been reset.","content":{}},"400":{"description":"Returned if `spaceKey` is invalid.","content":{}},"403":{"description":"Returned if the calling user doesn't have permission to reset the\nlook and feel.","content":{}},"404":{"description":"Returned if there is no space with the given `spaceKey`.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:configuration:confluence","write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/settings/lookandfeel/selected":{"put":{"tags":["Settings"],"summary":"Set look and feel settings","description":"Sets the look and feel settings to either the default settings or the\ncustom settings, for the site or a single space. Note, the default\nspace settings are inherited from the current global settings.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"setLookAndFeelSettings","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space for which the look and feel settings will be\nset. If this is not set, the global look and feel settings will be\nset.","schema":{"type":"string"}}],"requestBody":{"description":"The look and feel type to be set.","content":{"application/json":{"schema":{"type":"string","enum":["global","custom","theme"]}}},"required":true},"responses":{"200":{"description":"Returned if the look and feel settings were set.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Returned if;\n\n- The `spaceKey` is invalid.\n- The look and feel type is invalid.","content":{}},"403":{"description":"Returned if the look and feel type is set to 'theme' but the\nspace/site doesn't have a theme assigned.","content":{}},"404":{"description":"Returned if there is no space with the given `spaceKey`.","content":{}}},"deprecated":true,"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence","read:space.setting:confluence","write:configuration:confluence","write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/settings/systemInfo":{"get":{"tags":["Settings"],"summary":"Get system info","description":"Returns the system information for the Confluence Cloud tenant. This\ninformation is used by Atlassian.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getSystemInfo","responses":{"200":{"description":"Returned if the system information for the Confluence Cloud tenant\nis returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfoEntity"}}}},"403":{"description":"Returned when the user does not have permission to view the system\ninformation.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/settings/theme":{"get":{"tags":["Themes"],"summary":"Get themes","description":"Returns all themes, not including the default theme.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None","operationId":"getThemes","parameters":[{"name":"start","in":"query","description":"The starting index of the returned themes.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of themes to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the requested themes are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeArray"}}}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/settings/theme/selected":{"get":{"tags":["Themes"],"summary":"Get global theme","description":"Returns the globally assigned theme.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None","operationId":"getGlobalTheme","responses":{"200":{"description":"Returned if the global theme is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Theme"}}}},"404":{"description":"Returned if Confluence does not have a global theme assigned, i.e.\nthe default theme is used.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/settings/theme/{themeKey}":{"get":{"tags":["Themes"],"summary":"Get theme","description":"Returns a theme. This includes information about the theme name,\ndescription, and icon.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None","operationId":"getTheme","parameters":[{"name":"themeKey","in":"path","description":"The key of the theme to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested theme is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Theme"}}}},"404":{"description":"Returned if there is no theme with the given key.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["manage:confluence-configuration"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["manage:confluence-configuration"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:configuration:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space":{"get":{"tags":["Space"],"summary":"Get spaces","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns all spaces. The returned spaces are ordered alphabetically in\nascending order by space key.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).\nNote, the returned list will only contain spaces that the current user\nhas permission to view.","operationId":"getSpaces","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space to be returned. To return multiple spaces,\nspecify this parameter multiple times with different values.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"spaceId","in":"query","description":"The id of the space to be returned. To return multiple spaces,\nspecify this parameter multiple times with different values.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"type","in":"query","description":"Filter the results to spaces based on their type.","schema":{"type":"string","enum":["global","personal"]}},{"name":"status","in":"query","description":"Filter the results to spaces based on their status.","schema":{"type":"string","enum":["current","archived"]}},{"name":"label","in":"query","description":"Filter the results to spaces based on their label.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"favourite","in":"query","description":"Filter the results to the favourite spaces of the user specified by\n`favouriteUserKey`. Note, 'favourite' spaces are also\nknown as 'saved for later' spaces.","schema":{"type":"boolean"}},{"name":"favouriteUserKey","in":"query","description":"The userKey of the user, whose favourite spaces are used to filter\nthe results when using the `favourite` parameter.\n\nLeave blank for the current user. Use [Get user](#api-user-get) to\nget the userKey for a user.","schema":{"type":"string"}},{"$ref":"#/components/parameters/spaceExpand"},{"name":"start","in":"query","description":"The starting index of the returned spaces.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of spaces to return per page. Note, this may be\nrestricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested spaces are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceArray"}}}},"400":{"description":"Returned if spaces could not be fetched due to an invalid status being provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Space"],"summary":"Create space","description":"Creates a new space. Note, currently you cannot set space labels when\ncreating a space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Create Space(s)' global permission.","operationId":"createSpace","requestBody":{"description":"The space to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the space is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"400":{"description":"Returned if any of the following is true:\n\n- The request is invalid.\n- The space already exists.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the callig user does not have permission to create a space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space-details:confluence","write:space:confluence","write:space.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/space/_private":{"post":{"tags":["Space"],"summary":"Create private space","description":"Creates a new space that is only visible to the creator. This method is\nthe same as the [Create space](#api-space-post) method with permissions\nset to the current user only. Note, currently you cannot set space\nlabels when creating a space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Create Space(s)' global permission.","operationId":"createPrivateSpace","requestBody":{"description":"The space to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the space is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"400":{"description":"Returned if any of the following is true:\n\n- The request is invalid.\n- The space already exists.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user does not have permission to create a space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space-details:confluence","write:space:confluence","write:space.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"SpacePrivateCreate","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/space/{spaceKey}":{"get":{"tags":["Space"],"summary":"Get space","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns a space. This includes information like the name, description,\nand permissions, but not the content in the space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space.","operationId":"getSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be returned.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/spaceExpand"}],"responses":{"200":{"description":"Returned if the requested space is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Space"],"summary":"Update space","description":"Updates the name, description, or homepage of a space.\n\n- For security reasons, permissions cannot be updated via the API and\nmust be changed via the user interface instead.\n- Currently you cannot set space labels when updating a space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"updateSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to update.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The updated space.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the space is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key\n- The calling user does not have permission to update the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space-details:confluence","write:space:confluence","write:space.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Space"],"summary":"Delete space","description":"Deletes a space. Note, the space will be deleted in a long running task.\nTherefore, the space may not be deleted yet when this method has\nreturned. Clients should poll the status link that is returned in the\nresponse until the task completes.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"deleteSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to delete.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Returns a pointer to the status of the space deletion task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LongTask"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The calling user does not have permission to delete the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content.metadata:confluence","delete:space:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/space/{spaceKey}/content":{"get":{"tags":["Space"],"summary":"Get content for space","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns all content in a space. The returned content is grouped by type\n(pages then blogposts), then ordered by content ID in ascending order.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space. Note, the returned list will only\ncontain content that the current user has permission to view.","operationId":"getContentForSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content.","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","description":"Filter the results to content at the root level of the space or all content.","schema":{"type":"string","default":"all","enum":["all","root"]}},{"$ref":"#/components/parameters/contentExpand"},{"name":"start","in":"query","description":"The starting index of the returned content.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of content objects to return per page. Note, this\nmay be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested content is returned.","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/ContentArray"},"blogpost":{"$ref":"#/components/schemas/ContentArray"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space/{spaceKey}/permission":{"post":{"tags":["Space permissions"],"summary":"Add new permission to space","description":"Adds new permission to space.\n\nIf the permission to be added is a group permission, the group can be identified\nby its group name or group id.\n\nNote: Apps cannot access this REST resource - including when utilizing user impersonation.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"addPermissionToSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The permission to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePermissionRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the requested content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePermissionV2"}}}},"400":{"description":"Used for various errors. Such as:\n- Permission already exists for the given user or group.\n- 'read space' permission doesn't exist for the given user or group.\n- No group found with the given groupName or groupId","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user isn't authorized.","content":{}},"404":{"description":"Returned if any of the following is true:\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"x-codegen-request-body-name":"body","security":[{"basicAuth":[]},{"oAuthDefinitions":["read:space.permission:confluence","write:space.permission:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:space.permission:confluence","write:space.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/space/{spaceKey}/permission/custom-content":{"post":{"tags":["Space permissions"],"summary":"Add new custom content permission to space","description":"Adds new custom content permission to space.\n\nIf the permission to be added is a group permission, the group can be identified\nby its group name or group id.\n\nNote: Only apps can access this REST resource and only make changes to the respective app permissions.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"addCustomContentPermissions","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The permissions to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePermissionCustomContent"}}},"required":true},"responses":{"200":{"description":"Returned if the requested content is returned.","content":{}},"400":{"description":"Used for various errors. Such as:\n- Permission already exists for the given user or group.\n- 'read space' permission doesn't exist for the given user or group.\n- No group found with the given groupName or groupId","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user isn't authorized.","content":{}},"404":{"description":"Returned if any of the following is true:\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"x-codegen-request-body-name":"body","security":[{"basicAuth":[]},{"oAuthDefinitions":["read:space.permission:confluence","write:space.permission:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:space.permission:confluence","write:space.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/space/{spaceKey}/permission/{id}":{"delete":{"tags":["Space permissions"],"summary":"Remove a space permission","description":"Removes a space permission. Note that removing Read Space permission for a user or group will remove all\nthe space permissions for that user or group.\n\nNote: Apps cannot access this REST resource - including when utilizing user impersonation.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"removePermission","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Id of the permission to be deleted.","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Permission successfully removed.","content":{}},"400":{"description":"Used for various errors. Such as:\n- All of the admin permissions cannot be removed from a space.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the user isn't authorized.","content":{}},"404":{"description":"Returned if any of the following is true:\n- There is no permission with the given id.\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:space.permission:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:space.permission:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/space/{spaceKey}/content/{type}":{"get":{"tags":["Space"],"summary":"Get content by type for space","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns all content of a given type, in a space. The returned content is\nordered by content ID in ascending order.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space. Note, the returned list will only\ncontain content that the current user has permission to view.","operationId":"getContentByTypeForSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content.","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The type of content to return. `page`, `blogpost`, ``.","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","description":"Filter the results to content at the root level of the space or all\ncontent.","schema":{"type":"string","default":"all","enum":["all","root"]}},{"$ref":"#/components/parameters/contentExpand"},{"name":"start","in":"query","description":"The starting index of the returned content.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of content objects to return per page. Note, this\nmay be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}}],"responses":{"200":{"description":"Returned if the requested content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space/{spaceKey}/property":{"get":{"tags":["Space properties"],"summary":"Get space properties","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns all properties for the given space. Space properties are a key-value storage associated with a space.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.","operationId":"getSpaceProperties","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its properties.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the space\nproperty to expand. By default, the `version` object is expanded.\n\n- `version` returns information about the version of the content.\n- `space` returns the space that the properties are in.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["version","space"]}}},{"name":"start","in":"query","description":"The starting index of the returned objects.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of properties to return per page. Note, this may be\nrestricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Returned if the requested space properties are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePropertyArray"}}}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Space properties"],"summary":"Create space property","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nCreates a new space property.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:\n‘Admin’ permission for the space.","operationId":"createSpaceProperty","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space that the property will be created in.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The space property to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePropertyCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the space property is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceProperty"}}}},"400":{"description":"Returned if any of the following is true:\n\n- The space already has a value with the given key.\n- No property value was provided.","content":{}},"403":{"description":"Returned if the user does not have 'Admin' permission for the space.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}},"409":{"description":"Returned if the key already exists within the space.","content":{}},"413":{"description":"Returned if the value for the property is too long.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.property:confluence","write:space.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/space/{spaceKey}/property/{key}":{"get":{"tags":["Space properties"],"summary":"Get space property","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nReturns a space property.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.","operationId":"getSpaceProperty","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space that the property is in.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the space property.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the space\nproperty to expand. By default, the `version` object is expanded.\n\n- `version` returns information about the version of the content.\n- `space` returns the space that the properties are in.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["version","space"]}}}],"responses":{"200":{"description":"Returned if the requested space property is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceProperty"}}}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- There is no property with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Space properties"],"summary":"Update space property","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nUpdates a space property. Note, you cannot update the key of a space\nproperty, only the value.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:\n‘Admin’ permission for the space.","operationId":"updateSpaceProperty","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space that the property is in.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the property to be updated.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The space property being updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePropertyUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the space property is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceProperty"}}}},"400":{"description":"Returned if any of the following is true:\n\n- The given property has a different spaceKey to the one in the path.\n- The property has a different key to the one in the path.","content":{}},"403":{"description":"Returned if the user does not have permission to edit the space with\nthe given spaceKey","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given spaceKey\n- There is no property with the given key.\n- The calling user does not have permission to view the space.","content":{}},"409":{"description":"Returned if the given version is does not match the expected target\nversion of the updated property","content":{}},"413":{"description":"Returned if the value of the property is too long.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.property:confluence","write:space.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"post":{"tags":["Space properties"],"summary":"Create space property for key","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nCreates a new space property. This is the same as `POST\n/wiki/rest/api/space/{spaceKey}/property` but the key for the property is passed as a\npath parameter, rather than in the request body.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:\n‘Admin’ permission for the space.","operationId":"createSpacePropertyForKey","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space that the property will be created in.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the property to be created.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The space property to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpacePropertyCreateNoKey"}}},"required":true},"responses":{"200":{"description":"Returned if the space property is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceProperty"}}}},"400":{"description":"Returned if any of the following is true:\n\n- The space already has a value with the given key.\n- No property value was provided.","content":{}},"403":{"description":"Returned if the user does not have the 'Admin' permission for the\nspace.","content":{}},"413":{"description":"Returned if the value for the property is too long.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.property:confluence","write:space.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Space properties"],"summary":"Delete space property","deprecated":true,"description":"Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).\n\nDeletes a space property.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:\n‘Admin’ permission for the space.","operationId":"deleteSpaceProperty","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space that the property is in.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the property to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the space property is deleted.","content":{}},"403":{"description":"Returned if the user does not have 'Admin' permission for the space.","content":{}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given spaceKey\n- There is no property with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-props"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-props"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:space.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/space/{spaceKey}/settings":{"get":{"tags":["Space settings"],"summary":"Get space settings","description":"Returns the settings of a space. Currently only the\n`routeOverrideEnabled` setting can be returned.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space.","operationId":"getSpaceSettings","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its settings.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the space settings are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceSettings"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n\n- There is no space with the given key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Space settings"],"summary":"Update space settings","description":"Updates the settings for a space. Currently only the\n`routeOverrideEnabled` setting can be updated.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"updateSpaceSettings","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space whose settings will be updated.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The space settings to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceSettingsUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if space settings are updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceSettings"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n\n- There is no space with the given key.\n- The calling user does not have permission to update the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence","write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"SpaceSettingsUpdate","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/space/{spaceKey}/state":{"get":{"tags":["Content states"],"summary":"Get space suggested content states","description":"Get content states that are suggested in the space.\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nSpace view permission","operationId":"getSpaceContentStates","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content state settings.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested space exists, and user has space view permission.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentState"},"description":"Space suggested content states that users can choose from"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have space admin permission."},"404":{"description":"Returned if the space with given key can not be found."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space/{spaceKey}/state/settings":{"get":{"tags":["Content states"],"summary":"Get content state settings for space","description":"Get object describing whether content states are allowed at all, if custom content states or space content states\nare restricted, and a list of space content states allowed for the space if they are not restricted.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nSpace admin permission","operationId":"getContentStateSettings","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content state settings.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested space exists, and user has space admin permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStateSettings"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have space admin permission."},"404":{"description":"Returned if the space with given key can not be found."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space/{spaceKey}/state/content":{"get":{"tags":["Content states"],"summary":"Get content in space with given content state","description":"Finds paginated content with \n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nSpace View Permission","operationId":"getContentsWithState","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its content state settings.","required":true,"schema":{"type":"string"}},{"name":"state-id","in":"query","description":"The id of the content state to filter content by","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to expand.\nOptions include: space, version, history, children, etc.\n\nEx: space,version","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"integer","maximum":100,"minimum":0,"format":"int32","default":25}},{"name":"start","in":"query","description":"Number of result to start returning. (0 indexed)","schema":{"type":"integer","minimum":0,"format":"int32"}}],"responses":{"200":{"description":"Returned if search was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentArray"}}}},"400":{"description":"Returned if limit or start are out of range, stateId is omitted."},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request."},"403":{"description":"Returned if user does not have space view permission."},"404":{"description":"Returned if the space with given key can not be found."}},"security":[{"oAuthDefinitions":["read:confluence-content.all"]},{"basicAuth":[]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.all"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space/{spaceKey}/theme":{"get":{"tags":["Themes"],"summary":"Get space theme","description":"Returns the theme selected for a space, if one is set. If no space\ntheme is set, this means that the space is inheriting the global look\nand feel settings.\n\n**[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.","operationId":"getSpaceTheme","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for its theme.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested theme is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Theme"}}}},"404":{"description":"Returned if any of the following is true:\n\n- There is no space with the given key.\n- The space does not have a theme assigned to it.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["Themes"],"summary":"Set space theme","description":"Sets the theme for a space. Note, if you want to reset the space theme to\nthe default Confluence theme, use the 'Reset space theme' method instead\nof this method.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"setSpaceTheme","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to set the theme for.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the theme was set for the space.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Theme"}}}},"403":{"description":"Returned if the theme key is invalid.","content":{}},"404":{"description":"Returned if there is no space with the given key.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:space.setting:confluence","write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Themes"],"summary":"Reset space theme","description":"Resets the space theme. This means that the space will inherit the\nglobal look and feel settings\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space.","operationId":"resetSpaceTheme","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to reset the theme for.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the theme was reset for the space.","content":{}},"404":{"description":"Returned if there is no space with the given key.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:space.setting:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/space/{spaceKey}/watch":{"get":{"tags":["Content watches"],"summary":"Get space watchers","description":"Returns a list of watchers of a space","operationId":"getWatchersForSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to get watchers.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The start point of the collection to return.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The limit of the number of items to return, this may be restricted by fixed system limits.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if watchers list is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceWatchArray"}}}},"404":{"description":"Returned if there is no space with the given key","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:watcher:confluence","read:user:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:watcher:confluence","read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/space/{spaceKey}/label":{"get":{"tags":["Experimental"],"summary":"Get Space Labels","description":"Returns a list of labels associated with a space. Can provide a prefix as well as other filters to\nselect different types of labels.","operationId":"getLabelsForSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to get labels for.","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"Filters the results to labels with the specified prefix. If this parameter\nis not specified, then labels with any prefix will be returned.\n\n- `global` prefix is used by labels that are on content within the provided space.\n- `my` prefix can be explicitly added by a user when adding a label\nvia the UI, e.g. 'my:example-label'.\n- `team` prefix is used for labels applied to the space.","schema":{"type":"string","enum":["global","my","team"]}},{"name":"start","in":"query","description":"The starting index of the returned labels.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of labels to return per page. Note,\nthis may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the list of labels is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelArray"}}}},"404":{"description":"Returned if;\n- There is no space with the given space key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-space.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-space.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-experimental":true,"x-atlassian-connect-scope":"READ"},"post":{"tags":["Experimental"],"summary":"Add labels to a space","description":"Adds labels to a piece of content. Does not modify the existing labels.\n\nNotes:\n\n- Labels can also be added when creating content ([Create content](#api-content-post)).\n- Labels can be updated when updating content ([Update content](#api-content-id-put)).\nThis will delete the existing labels and replace them with the labels in\nthe request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the content.","operationId":"addLabelsToSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to add labels to.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The labels to add to the content.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LabelCreate"}}}},"required":true},"responses":{"200":{"description":"Returned if the labels are added to the content.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelArray"}}}},"400":{"description":"Returned if;\n\n- The body contains labels with invalid characters or too many characters.\n- The body contains too many labels.\n- The target content would contain too many labels after the operation.\n- The calling user does not have permission to edit labels.","content":{}},"403":{"description":"Returned if the calling user can view but not edit the content.","content":{}},"404":{"description":"Returned if;\n- There is no space with the given space key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:label:confluence","write:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Experimental"],"summary":"Remove label from a space","description":"","operationId":"deleteLabelFromSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to remove a labels from.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The name of the label to remove","required":true,"schema":{"type":"string"}},{"name":"prefix","in":"query","description":"The prefix of the label to remove. If not provided defaults to global.","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the label was successfully deleted.","content":{}},"400":{"description":"Returned if;\n- The user does not provide a label name","content":{}},"404":{"description":"Returned if;\n- There is no space with the given space key.\n- The calling user does not have permission to view the space.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-space"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-space"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:label:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-experimental":true,"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/template":{"put":{"tags":["Template"],"summary":"Update content template","description":"Updates a content template. Note, blueprint templates cannot be updated\nvia the REST API.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space to update a space template or 'Confluence Administrator'\nglobal permission to update a global template.","operationId":"updateContentTemplate","requestBody":{"description":"The updated content template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTemplateUpdate"}}},"required":true},"responses":{"200":{"description":"Returned if the template is updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTemplate"}}}},"400":{"description":"Returned if template name is null or an empty string.","content":{}},"403":{"description":"Returned if the calling user does not have permission.","content":{}},"404":{"description":"Returned if the calling user does not have permission to update the\ntemplate or if the template doesn't exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:template:confluence","read:content-details:confluence","write:template:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"post":{"tags":["Template"],"summary":"Create content template","description":"Creates a new content template. Note, blueprint templates cannot be created via the REST API.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space to create a space template or 'Confluence Administrator'\nglobal permission to create a global template.","operationId":"createContentTemplate","requestBody":{"description":"The content template to be created.\nThe content body must be in 'storage' format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTemplateCreate"}}},"required":true},"responses":{"200":{"description":"Returned if the template is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTemplate"}}}},"400":{"description":"Returned if template name is null or an empty string.","content":{}},"403":{"description":"Returned if the calling user does not have permission to create the\ntemplate.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:template:confluence","read:content-details:confluence","write:template:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/template/blueprint":{"get":{"tags":["Template"],"summary":"Get blueprint templates","description":"Returns all templates provided by blueprints. Use this method to retrieve\nall global blueprint templates or all blueprint templates in a space.\n\nNote, all global blueprints are inherited by each space. Space blueprints\ncan be customised without affecting the global blueprints.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space to view blueprints for the space and permission\nto access the Confluence site ('Can use' global permission) to view global blueprints.","operationId":"getBlueprintTemplates","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space to be queried for templates. If the `spaceKey`\nis not specified, global blueprint templates will be returned.","schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned templates.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of templates to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the template\nto expand.\n\n- `body` returns the content of the template in storage format.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["body"]}}}],"responses":{"200":{"description":"Returned if the requested templates are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlueprintTemplateArray"}}}},"403":{"description":"Returned if the calling user does not have permission to view\nblueprint templates.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:template:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/template/page":{"get":{"tags":["Template"],"summary":"Get content templates","description":"Returns all content templates. Use this method to retrieve all global\ncontent templates or all content templates in a space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space to view space templates and permission to\naccess the Confluence site ('Can use' global permission) to view global templates.","operationId":"getContentTemplates","parameters":[{"name":"spaceKey","in":"query","description":"The key of the space to be queried for templates. If the `spaceKey`\nis not specified, global templates will be returned.","schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned templates.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of templates to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":25}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the template\nto expand.\n\n- `body` returns the content of the template in storage format.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["body"]}}}],"responses":{"200":{"description":"Returned if the requested templates are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTemplateArray"}}}},"403":{"description":"Returned if the calling user does not have permission to view the\ncontent templates.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:template:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/template/{contentTemplateId}":{"get":{"tags":["Template"],"summary":"Get content template","description":"Returns a content template. This includes information about template,\nlike the name, the space or blueprint that the template is in, the body\nof the template, and more.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'View' permission for the space to view space templates and permission to\naccess the Confluence site ('Can use' global permission) to view global templates.","operationId":"getContentTemplate","parameters":[{"name":"contentTemplateId","in":"path","description":"The ID of the content template to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested template is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTemplate"}}}},"403":{"description":"Returned if;\n\n- There is no template with the given ID.\n- The calling user does not have permission to view the template.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:template:confluence","read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Template"],"summary":"Remove template","description":"Deletes a template. This results in different actions depending on the\ntype of template:\n\n- If the template is a content template, it is deleted.\n- If the template is a modified space-level blueprint template, it reverts\nto the template inherited from the global-level blueprint template.\n- If the template is a modified global-level blueprint template, it reverts\nto the default global-level blueprint template.\n\n Note, unmodified blueprint templates cannot be deleted.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n 'Admin' permission for the space to delete a space template or 'Confluence Administrator'\n global permission to delete a global template.","operationId":"removeTemplate","parameters":[{"name":"contentTemplateId","in":"path","description":"The ID of the template to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the template has been successfully been deleted.","content":{}},"403":{"description":"Returned if;\n\n- There is no template with the given ID.\n- The calling user does not have permission to delete the template."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:template:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"DELETE"}},"/wiki/rest/api/user":{"get":{"tags":["Users"],"summary":"Get user","description":"Returns a user. This includes information about the user, such as the\ndisplay name, account ID, profile picture, and more. The information returned may be\nrestricted by the user's profile visibility settings.\n\n**Note:** to add, edit, or delete users in your organization, see the\n[user management REST API](/cloud/admin/user-management/about/).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getUser","parameters":[{"name":"accountId","in":"query","description":"The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["operations","personalSpace","isExternalCollaborator"]}}}],"responses":{"200":{"description":"Returned if the requested user is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"403":{"description":"Returned if the calling user does not have permission to view users.","content":{}},"404":{"description":"Returned if a user with the given accountId does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-user"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-user"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/anonymous":{"get":{"tags":["Users"],"summary":"Get anonymous user","description":"Returns information about how anonymous users are represented, like the\nprofile picture and display name.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getAnonymousUser","parameters":[{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["operations"]}}}],"responses":{"200":{"description":"Returned if the anonymous user representation is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAnonymous"}}}},"403":{"description":"Returned if the calling user does not have permission to use\nConfluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-user"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-user"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:user:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/current":{"get":{"tags":["Users"],"summary":"Get current user","description":"Returns the currently logged-in user. This includes information about\nthe user, like the display name, userKey, account ID, profile picture,\nand more.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getCurrentUser","parameters":[{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["operations","personalSpace","isExternalCollaborator"]}}}],"responses":{"200":{"description":"Returned if the current user is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"403":{"description":"Returned if the calling user does not have permission to use\nConfluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-user"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-user"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/memberof":{"get":{"tags":["Users"],"summary":"Get group memberships for user","description":"Returns the groups that a user is a member of.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getGroupMembershipsForUser","parameters":[{"name":"accountId","in":"query","description":"The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned groups.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of groups to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"type":"integer","format":"int32","default":200}}],"responses":{"200":{"description":"Returned if the requested groups are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupArrayWithLinks"}}}},"403":{"description":"Returned if the calling user does not have permission to use\nConfluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-user"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-user"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:user:confluence","read:group:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/bulk":{"get":{"tags":["Users"],"summary":"Get multiple users using ids","description":"Returns user details for the ids provided in request.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getBulkUserLookup","parameters":[{"name":"accountId","in":"query","description":"A list of accountId's of users to be returned.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the user to\nexpand.\n\n - `operations` returns the operations that the user is allowed to do.\n - `personalSpace` returns the user's personal space, if it exists.\n - `isExternalCollaborator` returns whether the user is an external collaborator user.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["operations","personalSpace","isExternalCollaborator"]}}},{"name":"limit","in":"query","description":"The maximum number of results returned.\nCurrently API returns 200 results max.\nIf more that 200 ids are passed first 200 will be returned.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if, the list of users is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUserLookupArray"}}}},"403":{"description":"Returned if the calling user does not have permission to use\nConfluence.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-user"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-user"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:content-details:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/watch/content/{contentId}":{"get":{"tags":["Content watches"],"summary":"Get content watch status","description":"Returns whether a user is watching a piece of content. Choose the user by\ndoing one of the following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"getContentWatchStatus","parameters":[{"name":"contentId","in":"path","description":"The ID of the content to be queried for whether the specified user is\nwatching it.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"200":{"description":"Returned if the requested watch status is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatch"}}}},"403":{"description":"Returned if;\n\n- The calling user does not have permission to view the\ncontent.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No content exists for the specified `contentId`.","content":{}},"404":{"description":"Returned if no `contentId` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Content watches"],"summary":"Add content watcher","description":"Adds a user as a watcher to a piece of content. Choose the user by doing\none of the following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\nNote, you must add the `X-Atlassian-Token: no-check` header when making a\nrequest, as this operation has XSRF protection.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"addContentWatcher","parameters":[{"name":"contentId","in":"path","description":"The ID of the content to add the watcher to.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the watcher was successfully created. No response body is\nreturned.","content":{}},"403":{"description":"Returned if;\n\n- The `X-Atlassian-Token: no-check` header is not specified.\n- The calling user does not have permission to view the\ncontent.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No content exists for the specified `contentId`.","content":{}},"404":{"description":"Returned if no `contentId` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content watches"],"summary":"Remove content watcher","description":"Removes a user as a watcher from a piece of content. Choose the user by\ndoing one of the following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"removeContentWatcher","parameters":[{"name":"X-Atlassian-Token","in":"header","description":"Note, you must add header when making a\nrequest, as this operation has XSRF protection.","required":true,"schema":{"type":"string","default":"no-check"}},{"name":"contentId","in":"path","description":"The ID of the content to remove the watcher from.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the watcher was successfully deleted. No response body is\nreturned.","content":{}},"403":{"description":"Returned if;\n\n- The `X-Atlassian-Token: no-check` header is not specified.\n- The calling user does not have permission to view the\ncontent.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No content exists for the specified `contentId`.","content":{}},"404":{"description":"Returned if no `contentId` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/user/watch/label/{labelName}":{"get":{"tags":["Content watches"],"summary":"Get label watch status","description":"Returns whether a user is watching a label. Choose the user by doing one\nof the following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"isWatchingLabel","parameters":[{"name":"labelName","in":"path","description":"The name of the label to be queried for whether the specified user is\nwatching it.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"200":{"description":"Returned if the requested watch status is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatch"}}}},"403":{"description":"Returned if;\n\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No label exists for the specified `labelName`.","content":{}},"404":{"description":"Returned if no `labelName` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Content watches"],"summary":"Add label watcher","description":"Adds a user as a watcher to a label. Choose the user by doing one of the\nfollowing:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\nNote, you must add the `X-Atlassian-Token: no-check` header when making a\nrequest, as this operation has XSRF protection.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"addLabelWatcher","parameters":[{"name":"X-Atlassian-Token","in":"header","description":"Note, you must add header when making a\nrequest, as this operation has XSRF protection.","required":true,"schema":{"type":"string","default":"no-check"}},{"name":"labelName","in":"path","description":"The name of the label to add the watcher to.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the watcher was successfully created. No response body is\nreturned.","content":{}},"403":{"description":"Returned if;\n\n- The `X-Atlassian-Token: no-check` header is not specified.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No label exists for the specified `labelName`.","content":{}},"404":{"description":"Returned if no `labelName` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content watches"],"summary":"Remove label watcher","description":"Removes a user as a watcher from a label. Choose the user by doing one of\nthe following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"removeLabelWatcher","parameters":[{"name":"labelName","in":"path","description":"The name of the label to remove the watcher from.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the watcher was successfully deleted. No response body is\nreturned.","content":{}},"403":{"description":"Returned if;\n\n- The `X-Atlassian-Token: no-check` header is not specified.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No label exists for the specified `labelName`.","content":{}},"404":{"description":"Returned if no `labelName` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/user/watch/space/{spaceKey}":{"get":{"tags":["Content watches"],"summary":"Get space watch status","description":"Returns whether a user is watching a space. Choose the user by\ndoing one of the following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"isWatchingSpace","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to be queried for whether the specified user is\nwatching it.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"200":{"description":"Returned if the requested watch status is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatch"}}}},"403":{"description":"Returned if;\n\n- The calling user does not have permission to view the\nspace.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No space exists for the specified `spaceKey`.","content":{}},"404":{"description":"Returned if no `spaceKey` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Content watches"],"summary":"Add space watcher","description":"Adds a user as a watcher to a space. Choose the user by doing one of the\nfollowing:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\nNote, you must add the `X-Atlassian-Token: no-check` header when making a\nrequest, as this operation has XSRF protection.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"addSpaceWatcher","parameters":[{"name":"X-Atlassian-Token","in":"header","description":"Note, you must add header when making a\nrequest, as this operation has XSRF protection.","required":true,"schema":{"type":"string","default":"no-check"}},{"name":"spaceKey","in":"path","description":"The key of the space to add the watcher to.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the watcher was successfully created. No response body is\nreturned.","content":{}},"403":{"description":"Returned if;\n\n- The `X-Atlassian-Token: no-check` header is not specified.\n- The calling user does not have permission to view the\nspace.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No space exists for the specified `spaceKey`.","content":{}},"404":{"description":"Returned if no `spaceKey` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["Content watches"],"summary":"Remove space watch","description":"Removes a user as a watcher from a space. Choose the user by doing one of\nthe following:\n\n- Specify a user via a query parameter: Use the `accountId` to identify the user.\n- Do not specify a user: The currently logged-in user will be used.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission if specifying a user, otherwise\npermission to access the Confluence site ('Can use' global permission).","operationId":"removeSpaceWatch","parameters":[{"name":"spaceKey","in":"path","description":"The key of the space to remove the watcher from.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/userLookupKey"},{"$ref":"#/components/parameters/userLookupUsername"},{"$ref":"#/components/parameters/userLookupAccountId"}],"responses":{"204":{"description":"Returned if the watcher was successfully deleted. No response body is returned.","content":{}},"403":{"description":"Returned if;\n\n- The `X-Atlassian-Token: no-check` header is not specified.\n- The calling user does not have permission to view the space.\n- A user is specified via a query parameter and the calling user is\nnot a Confluence administrator.\n- No space exists for the specified `spaceKey`.","content":{}},"404":{"description":"Returned if no `spaceKey` is specified.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:confluence-content"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:confluence-content"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["write:watcher:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"}},"/wiki/rest/api/user/email":{"get":{"tags":["Users"],"summary":"Get user email address","description":"Returns a user's email address. This API is only available to apps approved by\nAtlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getPrivacyUnsafeUserEmail","parameters":[{"name":"accountId","in":"query","description":"The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the requested user's email is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountIdEmailRecord"}}}},"400":{"description":"Returned if the calling app is not approved to use this API.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if a user with the given accountId does not exist.","content":{}},"501":{"description":"Indicates that the API is not currently enabled.","content":{}}},"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"ACCESS_EMAIL_ADDRESSES"}},"/wiki/rest/api/user/email/bulk":{"get":{"tags":["Users"],"summary":"Get user email addresses in batch","description":"Returns user email addresses for a set of accountIds. This API is only available to apps approved by\nAtlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).\n\nAny accounts which are not available will not be included in the result.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getPrivacyUnsafeUserEmailBulk","parameters":[{"name":"accountId","in":"query","description":"The account IDs of the users.","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountIdEmailRecordArray"}}}},"400":{"description":"Returned if the calling app is not approved to use this API.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"501":{"description":"Indicates that the API is not currently enabled.","content":{}}},"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"ACCESS_EMAIL_ADDRESSES"}},"/atlassian-connect/1/app/module/dynamic":{"get":{"tags":["Dynamic modules"],"summary":"Get modules","description":"Returns all modules registered dynamically by the calling app.\n\n**[Permissions](#permissions) required:** Only Connect apps can make this request.","operationId":"getModules","responses":{"200":{"description":"Returned if the request is successful.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectModules"}}}},"401":{"description":"Returned if the call is not from a Connect app.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DynamicModulesErrorMessage"}},"message":{"example":"The request is not from a Connect app."}}}},"deprecated":false,"x-experimental":true,"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["Dynamic modules"],"summary":"Register modules","description":"Registers a list of modules. For the list of modules that support dynamic registration, see [Dynamic modules](https://developer.atlassian.com/cloud/confluence/dynamic-modules/).\n\n**[Permissions](#permissions) required:** Only Connect apps can make this request.","operationId":"registerModules","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ConnectModules"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{}},"400":{"description":"Returned if:\n* any of the provided modules is invalid. For example, required properties are missing.\n* any of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.\n\nDetails of the issues encountered are included in the error message.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DynamicModulesErrorMessage"}},"message":{"example":"Installation failed. The app com.example.app.key has duplicate module keys: [module-key]. Please contact the app vendor."}}},"401":{"description":"Returned if the call is not from a Connect app.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DynamicModulesErrorMessage"}},"message":{"example":"The request is not from a Connect app."}}}},"deprecated":false,"x-experimental":true,"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Dynamic modules"],"summary":"Remove modules","description":"Remove all or a list of modules registered by the calling app.\n\n**[Permissions](#permissions) required:** Only Connect apps can make this request.","operationId":"removeModules","parameters":[{"name":"moduleKey","in":"query","description":"The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.\nFor example, `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`.\nNonexistent keys are ignored.","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Returned if the request is successful.","content":{}},"401":{"description":"Returned if the call is not from a Connect app.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DynamicModulesErrorMessage"}},"message":{"example":"The request is not from a Connect app."}}}},"deprecated":false,"x-experimental":true,"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/wiki/rest/api/analytics/content/{contentId}/views":{"get":{"tags":["Analytics"],"summary":"Get views","description":"Get the total number of views a piece of content has.","operationId":"getViews","parameters":[{"name":"contentId","in":"path","description":"The ID of the content to get the views for.","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","description":"The number of views for the content since the date.","schema":{"type":"string"},"example":"2021-03-21T00:00:00.000Z"}],"responses":{"200":{"description":"Returns the total number of views for the content.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The content ID."},"count":{"type":"integer","description":"The total number of views for the content."}}}}}},"400":{"description":"Returned if client input is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{}},"403":{"description":"Returned if the authentication credentials are missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n- There is no content with the given ID."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:analytics.content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/analytics/content/{contentId}/viewers":{"get":{"tags":["Analytics"],"summary":"Get viewers","description":"Get the total number of distinct viewers a piece of content has.","operationId":"getViewers","parameters":[{"name":"contentId","in":"path","description":"The ID of the content to get the viewers for.","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","description":"The number of views for the content since the date.","schema":{"type":"string"},"example":"2021-03-21T00:00:00.000Z"}],"responses":{"200":{"description":"Returns the total number of distinct viewers for the content.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The content ID."},"count":{"type":"integer","description":"The total number of distinct viewers for the content."}}}}}},"400":{"description":"Returned if client input is invalid."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{}},"403":{"description":"Returned if the authentication credentials are missing\nfrom the request.","content":{}},"404":{"description":"Returned if;\n- There is no content with the given ID."}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:confluence-content.summary"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:confluence-content.summary"]},{"scheme":"oAuthDefinitions","state":"Beta","scopes":["read:analytics.content:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/{userId}/property":{"get":{"tags":["User properties"],"summary":"Get user properties","description":"Returns the properties for a user as list of property keys. For more information\nabout user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n`Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getUserProperties","parameters":[{"name":"userId","in":"path","description":"The account ID of the user to be queried for its properties.","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The starting index of the returned properties.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of properties to return per page.\nNote, this may be restricted by fixed system limits.","schema":{"minimum":0,"maximum":25,"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Returned if the requested properties are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPropertyKeyArray"}}}},"400":{"description":"Returned if request has malformed syntax or userId is not a valid user id.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"403":{"description":"Returned if the user does not have the correct permissions.","content":{}},"404":{"description":"Returned if there is no user with the given user ID.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:user.property:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:user.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"}},"/wiki/rest/api/user/{userId}/property/{key}":{"get":{"tags":["User properties"],"summary":"Get user property","description":"Returns the property corresponding to `key` for a user. For more information\nabout user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n`Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"getUserProperty","parameters":[{"name":"userId","in":"path","description":"The account ID of the user to be queried for its properties.","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the user property.","required":true,"schema":{"type":"string","pattern":"^[-_a-zA-Z0-9]+$"}}],"responses":{"200":{"description":"Returned if the requested properties are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProperty"}}}},"400":{"description":"Returned if;\n\n- The key is too long.\n- Request has malformed syntax or userId is not a valid user id.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"403":{"description":"Returned if the user does not have the correct permissions.","content":{}},"404":{"description":"Returned if;\n\n- There is no user with the given user ID\n- There is no user property with the given key","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:user.property:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:user.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ"},"put":{"tags":["User properties"],"summary":"Update user property","description":"Updates a property for the given user. Note, you cannot update the key of a user property, only the value.\nFor more information about user properties, see\n[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n`Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"updateUserProperty","parameters":[{"name":"userId","in":"path","description":"The account ID of the user. The accountId uniquely identifies the user across all Atlassian\nproducts. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the user property.","required":true,"schema":{"type":"string","pattern":"^[-_a-zA-Z0-9]+$"}}],"requestBody":{"description":"The user property to be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPropertyUpdate"}}},"required":true},"responses":{"204":{"description":"Returned if the user property is updated."},"400":{"description":"Returned if;\n\n- The key is too long.\n- The value is empty.\n- The value is too long.\n- Request has malformed syntax or userId is not a valid user id.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"403":{"description":"Returned if the user does not have the correct permissions.","content":{}},"404":{"description":"Returned if;\n\n- There is no user property with the given key.\n- There is no user with the given user id.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:user.property:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:user.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"post":{"tags":["User properties"],"summary":"Create user property by key","description":"Creates a property for a user. For more information about user properties, see [Confluence entity properties]\n(https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n`Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n\n`Note:` the number of properties which could be created per app in a tenant for each user might be\nrestricted by fixed system limits.\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"createUserProperty","parameters":[{"name":"userId","in":"path","description":"The account ID of the user. The accountId uniquely identifies the user across all Atlassian\nproducts. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the user property.","required":true,"schema":{"type":"string","pattern":"^[-_a-zA-Z0-9]+$"}}],"requestBody":{"description":"The user property to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPropertyCreate"}}},"required":true},"responses":{"201":{"description":"Returned if the user property is created."},"400":{"description":"Returned if;\n\n- The key is too long.\n- The value is empty.\n- The value is too long.\n- Request has malformed syntax or userId is not a valid user id.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"403":{"description":"Returned if the user does not have the correct permissions.","content":{}},"404":{"description":"Returned if there is no user with the given user id.","content":{}},"409":{"description":"Returned if the key already exists for the user.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:user.property:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:user.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-codegen-request-body-name":"body","x-atlassian-connect-scope":"WRITE"},"delete":{"tags":["User properties"],"summary":"Delete user property","description":"Deletes a property for the given user.\nFor more information about user properties, see\n[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n`Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).","operationId":"deleteUserProperty","parameters":[{"name":"userId","in":"path","description":"The account ID of the user. The accountId uniquely identifies the user across all Atlassian\nproducts. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","description":"The key of the user property.","required":true,"schema":{"type":"string","pattern":"^[-_a-zA-Z0-9]+$"}}],"responses":{"204":{"description":"Returned if the user property is deleted."},"400":{"description":"Returned if;\n\n- The key is too long.\n- Request has malformed syntax or userId is not a valid user id.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"403":{"description":"Returned if the user does not have the correct permissions.","content":{}},"404":{"description":"Returned if;\n\n- There is no user property with the given key\n- There is no user with the given user id","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:user.property:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:user.property:confluence"]}],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE"}}},"components":{"schemas":{"AccountId":{"required":["accountId"],"type":"object","properties":{"accountId":{"type":"string"}}},"AccountIdEmailRecord":{"required":["accountId","email"],"type":"object","properties":{"accountId":{"type":"string"},"email":{"type":"string"}}},"AccountIdEmailRecordArray":{"type":"array","items":{"$ref":"#/components/schemas/AccountIdEmailRecord"}},"AffectedObject":{"required":["name","objectType"],"type":"object","properties":{"name":{"type":"string"},"objectType":{"type":"string"}}},"AsyncId":{"required":["asyncId"],"type":"object","properties":{"asyncId":{"type":"string"}}},"AttachmentUpdate":{"required":["id","type","version"],"type":"object","properties":{"version":{"required":["number"],"type":"object","properties":{"number":{"type":"integer","description":"The version number.","format":"int32"}},"description":"The attachment version. Set this to the current version number of the\nattachment. Note, the version number only needs to be incremented when\nupdating the actual attachment, not its properties."},"id":{"type":"string","description":"The ID of the attachment to be updated."},"type":{"type":"string","description":"Set this to `attachment`.","enum":["attachment"]},"title":{"maxLength":255,"type":"string","description":"The updated name of the attachment."},"metadata":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type of the attachment, e.g. 'img/jpg'."},"comment":{"type":"string","description":"The comment for this update."}}},"container":{"required":["id","type"],"type":"object","properties":{"id":{"type":"string","description":"The `id` of the parent content."},"type":{"type":"string","description":"The content type. You can only attach attachments to content\nof type: `page`, `blogpost`."}},"description":"The new content to attach the attachment to."}}},"AuditRecord":{"required":["affectedObject","associatedObjects","author","category","changedValues","creationDate","description","remoteAddress","summary","sysAdmin"],"type":"object","properties":{"author":{"required":["displayName","operations","type"],"type":"object","properties":{"type":{"type":"string","default":"user","enum":["user"]},"displayName":{"type":"string"},"operations":{"nullable":true,"type":"object","properties":{}},"username":{"$ref":"#/components/schemas/GenericUserName"},"userKey":{"$ref":"#/components/schemas/GenericUserKey"},"accountId":{"$ref":"#/components/schemas/GenericAccountId"},"accountType":{"type":"string"},"externalCollaborator":{"type":"boolean"},"isExternalCollaborator":{"type":"boolean","description":"Whether the user is an external collaborator user"},"publicName":{"type":"string","description":"The public name or nickname of the user. Will always contain a value."}}},"remoteAddress":{"type":"string"},"creationDate":{"type":"integer","description":"The creation date-time of the audit record, as a timestamp.","format":"int64"},"summary":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"sysAdmin":{"type":"boolean"},"superAdmin":{"type":"boolean"},"affectedObject":{"$ref":"#/components/schemas/AffectedObject"},"changedValues":{"type":"array","items":{"$ref":"#/components/schemas/ChangedValue"}},"associatedObjects":{"type":"array","items":{"$ref":"#/components/schemas/AffectedObject"}}}},"AuditRecordArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AuditRecord"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"AuditRecordCreate":{"required":["remoteAddress"],"type":"object","properties":{"author":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Set to 'user'.","default":"user","enum":["user"]},"displayName":{"type":"string","description":"The name that is displayed on the audit log in the Confluence UI."},"operations":{"type":"object","properties":{},"description":"Always defaults to null."},"username":{"$ref":"#/components/schemas/GenericUserName"},"userKey":{"$ref":"#/components/schemas/GenericUserKey"}},"description":"The user that actioned the event. If `author` is not specified, then all\n`author` properties will be set to null/empty, except for `type` which\nwill be set to 'user'."},"remoteAddress":{"type":"string","description":"The IP address of the computer where the event was initiated from."},"creationDate":{"type":"integer","description":"The creation date-time of the audit record, as a timestamp. This is converted\nto a date-time display in the Confluence UI. If the `creationDate` is not\nspecified, then it will be set to the timestamp for the current date-time.","format":"int64"},"summary":{"type":"string","description":"The summary of the event, which is displayed in the 'Change' column on\nthe audit log in the Confluence UI."},"description":{"type":"string","description":"A long description of the event, which is displayed in the 'Description'\nfield on the audit log in the Confluence UI."},"category":{"type":"string","description":"The category of the event, which is displayed in the 'Event type' column\non the audit log in the Confluence UI."},"sysAdmin":{"type":"boolean","description":"Indicates whether the event was actioned by a system administrator.","default":false},"affectedObject":{"$ref":"#/components/schemas/AffectedObject"},"changedValues":{"type":"array","description":"The values that were changed in the event.","items":{"$ref":"#/components/schemas/ChangedValue"}},"associatedObjects":{"type":"array","description":"Objects that were associated with the event. For example, if the event\nwas a space permission change then the associated object would be the\nspace.","items":{"$ref":"#/components/schemas/AffectedObject"}}}},"AvailableContentStates":{"required":["spaceContentStates","customContentStates"],"type":"object","properties":{"spaceContentStates":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ContentState"},"description":"Space suggested content states that can be used in the space.\nThis list can be empty if there are no space content states defined in the space or if space content states are disabled in the space.\nAll spaces start with 4 default space content states, and this can be modified in the UI under space settings."},"customContentStates":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ContentState"},"description":"Custom content states that can be used by the user on the content of this call.\nThis list can be empty if there are no custom content states defined by the user or if custom content states are disabled in the space of the content.\nThis will at most have 3 of the most recently published content states. \nOnly the calling user has access to place these states on content, but all users can see these states once they are placed."}}},"BlueprintTemplate":{"required":["_links","description","labels","name","originalTemplate","referencingBlueprint","templateId","templateType"],"type":"object","properties":{"templateId":{"type":"string"},"originalTemplate":{"required":["moduleKey","pluginKey"],"type":"object","properties":{"pluginKey":{"type":"string"},"moduleKey":{"type":"string"}}},"referencingBlueprint":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"space":{"type":"object","additionalProperties":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"templateType":{"type":"string"},"editorVersion":{"type":"string"},"body":{"$ref":"#/components/schemas/ContentTemplateBody"},"_expandable":{"type":"object","properties":{"body":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"BlueprintTemplateArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BlueprintTemplate"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ButtonLookAndFeel":{"required":["backgroundColor","color"],"type":"object","nullable":true,"properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}}},"Breadcrumb":{"required":["label","separator","url"],"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"},"separator":{"type":"string"}}},"ChangedValue":{"required":["name","newValue","oldValue"],"type":"object","properties":{"name":{"type":"string"},"oldValue":{"type":"string"},"hiddenOldValue":{"type":"string"},"newValue":{"type":"string"},"hiddenNewValue":{"type":"string"}}},"ConnectModule":{"type":"object","description":"A [Connect module](https://developer.atlassian.com/cloud/confluence/modules/admin-page/) in the same format as in the\n[app descriptor](https://developer.atlassian.com/cloud/confluence/app-descriptor/).","example":{"key":"my-webitem","location":"system.admin/globalsettings","url":"/my-web-item","name":{"value":"My Web Item"}}},"ConnectModules":{"required":["modules"],"type":"object","properties":{"modules":{"type":"array","items":{"$ref":"#/components/schemas/ConnectModule"},"description":"A list of app modules in the same format as the `modules` property in the\n[app descriptor](https://developer.atlassian.com/cloud/confluence/app-descriptor/)."}},"example":{"webItems":[{"key":"my-webitem","location":"system.admin/globalsettings","url":"/my-web-item","name":{"value":"My Web Item"}}],"adminPages":[{"key":"my-admin-page","name":{"value":"My Admin Page"},"url":"/my-admin-page"}]}},"Container":{"type":"object","nullable":true,"additionalProperties":true,"description":"Container for content. This can be either a space (containing a page or blogpost)\nor a page/blog post (containing an attachment or comment)"},"ContainerLookAndFeel":{"required":["background","backgroundColor","backgroundImage","backgroundSize","borderRadius","padding"],"type":"object","nullable":true,"properties":{"background":{"type":"string"},"backgroundAttachment":{"type":"string","nullable":true},"backgroundBlendMode":{"type":"string","nullable":true},"backgroundClip":{"type":"string","nullable":true},"backgroundColor":{"type":"string","nullable":true},"backgroundImage":{"type":"string","nullable":true},"backgroundOrigin":{"type":"string","nullable":true},"backgroundPosition":{"type":"string","nullable":true},"backgroundRepeat":{"type":"string","nullable":true},"backgroundSize":{"type":"string","nullable":true},"padding":{"type":"string"},"borderRadius":{"type":"string"}}},"ContainerSummary":{"required":["displayUrl","title"],"type":"object","properties":{"title":{"type":"string"},"displayUrl":{"type":"string"}}},"AttachmentPropertiesUpdateBody":{"required":["id","type","version"],"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Set this to \"attachment\""},"status":{"type":"string"},"title":{"type":"string"},"container":{"$ref":"#/components/schemas/Container"},"metadata":{"type":"object","properties":{"mediaType":{"type":"string"}}},"extensions":{"type":"object"},"version":{"$ref":"#/components/schemas/Version"}}},"Content":{"required":["status","type"],"nullable":true,"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"type":{"type":"string","description":"Can be \"page\", \"blogpost\", \"attachment\" or \"content\""},"status":{"type":"string"},"title":{"type":"string"},"space":{"$ref":"#/components/schemas/Space"},"history":{"$ref":"#/components/schemas/ContentHistory"},"version":{"$ref":"#/components/schemas/Version"},"ancestors":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/Content"}},"operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationCheckResult"}},"children":{"$ref":"#/components/schemas/ContentChildren"},"childTypes":{"$ref":"#/components/schemas/ContentChildType"},"descendants":{"$ref":"#/components/schemas/ContentChildren"},"container":{"$ref":"#/components/schemas/Container"},"body":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/ContentBody"},"export_view":{"$ref":"#/components/schemas/ContentBody"},"styled_view":{"$ref":"#/components/schemas/ContentBody"},"storage":{"$ref":"#/components/schemas/ContentBody"},"wiki":{"$ref":"#/components/schemas/ContentBody"},"editor":{"$ref":"#/components/schemas/ContentBody"},"editor2":{"$ref":"#/components/schemas/ContentBody"},"anonymous_export_view":{"$ref":"#/components/schemas/ContentBody"},"atlas_doc_format":{"$ref":"#/components/schemas/ContentBody"},"dynamic":{"$ref":"#/components/schemas/ContentBody"},"raw":{"$ref":"#/components/schemas/ContentBody"},"_expandable":{"type":"object","properties":{"editor":{"type":"string"},"view":{"type":"string"},"export_view":{"type":"string"},"styled_view":{"type":"string"},"storage":{"type":"string"},"editor2":{"type":"string"},"anonymous_export_view":{"type":"string"},"atlas_doc_format":{"type":"string"},"wiki":{"type":"string"},"dynamic":{"type":"string"},"raw":{"type":"string"}}}}},"restrictions":{"type":"object","properties":{"read":{"$ref":"#/components/schemas/ContentRestriction"},"update":{"$ref":"#/components/schemas/ContentRestriction"},"_expandable":{"type":"object","properties":{"read":{"type":"string"},"update":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"metadata":{"$ref":"#/components/schemas/ContentMetadata"},"macroRenderedOutput":{"type":"object","additionalProperties":{"type":"object"}},"extensions":{"type":"object"},"_expandable":{"type":"object","properties":{"childTypes":{"type":"string"},"container":{"type":"string"},"metadata":{"type":"string"},"operations":{"type":"string"},"children":{"type":"string"},"restrictions":{"type":"string"},"history":{"type":"string"},"ancestors":{"type":"string"},"body":{"type":"string"},"version":{"type":"string"},"descendants":{"type":"string"},"space":{"type":"string"},"extensions":{"type":"string"},"schedulePublishDate":{"type":"string"},"schedulePublishInfo":{"type":"string"},"macroRenderedOutput":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}},"description":"Base object for all content types."},"ContentArray":{"required":["_links","results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Content"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentBlogpost":{"description":"Representation of a blogpost (content)","allOf":[{"$ref":"#/components/schemas/Content"},{"required":["_links","metadata"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/ContentMetadata"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}}]},"ContentBlueprintDraft":{"required":["title","type","version"],"type":"object","properties":{"version":{"required":["number"],"type":"object","properties":{"number":{"type":"integer","description":"The version number. Set this to `1`.","format":"int32"}},"additionalProperties":true,"description":"The version for the new content."},"title":{"maxLength":255,"type":"string","description":"The title of the content. If you don't want to change the title,\nset this to the current title of the draft."},"type":{"type":"string","description":"The type of content. Set this to `page`.","enum":["page"]},"status":{"type":"string","description":"The status of the content. Set this to `current` or omit it altogether.","default":"current","enum":["current"]},"space":{"required":["key"],"type":"object","properties":{"key":{"type":"string","description":"The key of the space","format":"int32"}},"additionalProperties":true,"description":"The space for the content."},"ancestors":{"type":"array","description":"The new ancestor (i.e. parent page) for the content. If you have\nspecified an ancestor, you must also specify a `space` property\nin the request body for the space that the ancestor is in.\n\nNote, if you specify more than one ancestor, the last ID in the array\nwill be selected as the parent page for the content.","items":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The content ID of the ancestor."}}},"nullable":true}},"additionalProperties":true},"AsyncContentBody":{"type":"object","properties":{"value":{"type":"string"},"representation":{"type":"string","enum":["view","export_view","styled_view","storage","editor","editor2","anonymous_export_view","wiki","atlas_doc_format"]},"renderTaskId":{"type":"string"},"error":{"type":"string"},"status":{"description":"Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may choose to continue polling, or use the cached value.","type":"string","enum":["WORKING","QUEUED","FAILED","COMPLETED","RERUNNING"]},"embeddedContent":{"type":"array","items":{"$ref":"#/components/schemas/EmbeddedContent"}},"webresource":{"$ref":"#/components/schemas/WebResourceDependencies"},"mediaToken":{"type":"object","properties":{"collectionIds":{"type":"array","items":{"type":"string"}},"contentId":{"type":"string"},"expiryDateTime":{"type":"string"},"fileIds":{"type":"array","items":{"type":"string"}},"token":{"type":"string"}}},"_expandable":{"type":"object","properties":{"content":{"type":"string"},"embeddedContent":{"type":"string"},"webresource":{"type":"string"},"mediaToken":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentBody":{"required":["representation","value"],"type":"object","properties":{"value":{"type":"string"},"representation":{"type":"string","enum":["view","export_view","styled_view","storage","editor","editor2","anonymous_export_view","wiki","atlas_doc_format","raw"]},"embeddedContent":{"type":"array","items":{"$ref":"#/components/schemas/EmbeddedContent"}},"webresource":{"$ref":"#/components/schemas/WebResourceDependencies"},"mediaToken":{"type":"object","properties":{"collectionIds":{"type":"array","items":{"type":"string"}},"contentId":{"type":"string"},"expiryDateTime":{"type":"string"},"fileIds":{"type":"array","items":{"type":"string"}},"token":{"type":"string"}}},"_expandable":{"type":"object","properties":{"content":{"type":"string"},"embeddedContent":{"type":"string"},"webresource":{"type":"string"},"mediaToken":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentBodyCreate":{"required":["representation","value"],"type":"object","additionalProperties":true,"properties":{"value":{"type":"string","description":"The body of the content in the relevant format."},"representation":{"type":"string","description":"The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'.","enum":["view","export_view","styled_view","storage","editor","editor2","anonymous_export_view","wiki","atlas_doc_format","plain","raw"]}},"description":"This object is used when creating or updating content."},"ContentChildren":{"type":"object","additionalProperties":true,"properties":{"attachment":{"$ref":"#/components/schemas/ContentArray"},"comment":{"$ref":"#/components/schemas/ContentArray"},"page":{"$ref":"#/components/schemas/ContentArray"},"_expandable":{"type":"object","additionalProperties":true,"properties":{"attachment":{"type":"string"},"comment":{"type":"string"},"page":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentBodyCreateStorage":{"required":["representation","value"],"type":"object","additionalProperties":true,"properties":{"value":{"type":"string","description":"The body of the content in the relevant format."},"representation":{"type":"string","description":"The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'.","enum":["storage","view","export_view","styled_view","editor","editor2","anonymous_export_view","wiki","atlas_doc_format"]}},"description":"This object is used when creating or updating content."},"ContentChildType":{"type":"object","properties":{"attachment":{"required":["_links","value"],"type":"object","properties":{"value":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"comment":{"required":["_links","value"],"type":"object","properties":{"value":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"page":{"required":["_links","value"],"type":"object","properties":{"value":{"type":"boolean"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"_expandable":{"type":"object","properties":{"all":{"type":"string"},"attachment":{"type":"string"},"comment":{"type":"string"},"page":{"type":"string"},"whiteboard":{"type":"string"}}}},"additionalProperties":true,"description":"Shows whether a piece of content has attachments, comments, or child pages/whiteboards.\nNote, this doesn't actually contain the child objects."},"ContentCreate":{"required":["type"],"type":"object","nullable":true,"additionalProperties":true,"properties":{"id":{"nullable":true,"type":"string","description":"The ID of the draft content. Required when publishing a draft."},"title":{"nullable":true,"maxLength":255,"type":"string"},"type":{"type":"string","description":"The type of the new content. Custom content types defined by apps are also supported. eg. 'page', 'blogpost', 'comment' etc."},"space":{"nullable":true,"required":["key"],"type":"object","properties":{"id":{"nullable":true,"type":"integer","format":"int64"},"name":{"nullable":true,"type":"string"},"icon":{"$ref":"#/components/schemas/Icon"},"identifiers":{"$ref":"#/components/schemas/GlobalSpaceIdentifier"},"description":{"type":"object","nullable":true,"properties":{"plain":{"$ref":"#/components/schemas/SpaceDescription"},"view":{"$ref":"#/components/schemas/SpaceDescription"},"_expandable":{"type":"object","properties":{"view":{"type":"string"},"plain":{"type":"string"}}}}},"homepage":{"$ref":"#/components/schemas/Content"},"type":{"nullable":true,"type":"string"},"metadata":{"nullable":true,"type":"object","properties":{"labels":{"$ref":"#/components/schemas/LabelArray"},"_expandable":{"type":"object"}}},"operations":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/OperationCheckResult"}},"permissions":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/SpacePermission"}},"status":{"nullable":true,"type":"string"},"settings":{"$ref":"#/components/schemas/SpaceSettings"},"theme":{"$ref":"#/components/schemas/Theme"},"lookAndFeel":{"$ref":"#/components/schemas/LookAndFeel"},"history":{"required":["createdDate"],"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"createdBy":{"$ref":"#/components/schemas/User"}}},"key":{"type":"string","description":"The key of the space."},"links":{"nullable":true,"type":"object","additionalProperties":true}},"description":"The space that the content is being created in."},"status":{"type":"string","description":"The status of the new content.","default":"current","enum":["current","deleted","historical","draft"]},"container":{"nullable":true,"required":["id","type"],"type":"object","additionalProperties":true,"properties":{"id":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The `id` of the container."},"type":{"type":"string","description":"The `type` of the container."}},"description":"The container of the content. Required if type is `comment` or certain types of\ncustom content. If you are trying to create a comment that is a child of another comment,\nspecify the parent comment in the ancestors field, not in this field."},"ancestors":{"nullable":true,"type":"array","description":"The parent content of the new content. If you are creating a top-level `page` or `comment`,\nthis can be left blank. If you are creating a child page, this is where the parent page id goes.\nIf you are creating a child comment, this is where the parent comment id goes. Only one parent\ncontent id can be specified.","items":{"required":["id"],"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"The `id` of the parent content."}}}},"body":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/ContentBodyCreate"},"export_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"styled_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"storage":{"$ref":"#/components/schemas/ContentBodyCreate"},"editor":{"$ref":"#/components/schemas/ContentBodyCreate"},"editor2":{"$ref":"#/components/schemas/ContentBodyCreate"},"wiki":{"$ref":"#/components/schemas/ContentBodyCreate"},"anonymous_export_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"plain":{"$ref":"#/components/schemas/ContentBodyCreate"},"atlas_doc_format":{"$ref":"#/components/schemas/ContentBodyCreate"},"raw":{"$ref":"#/components/schemas/ContentBodyCreate"}},"description":"The body of the new content. Does not apply to attachments.\nOnly one body format should be specified as the property for\nthis object, e.g. `storage`.\n\nNote, `editor2` format is used by Atlassian only. `anonymous_export_view` is\nthe same as `export_view` format but only content viewable by an anonymous\nuser is included."}}},"ContentHistory":{"required":["latest"],"type":"object","nullable":true,"properties":{"latest":{"type":"boolean"},"createdBy":{"$ref":"#/components/schemas/User"},"ownedBy":{"$ref":"#/components/schemas/User"},"lastOwnedBy":{"$ref":"#/components/schemas/User"},"createdDate":{"type":"string","format":"date-time"},"lastUpdated":{"$ref":"#/components/schemas/Version"},"previousVersion":{"$ref":"#/components/schemas/Version"},"contributors":{"type":"object","properties":{"publishers":{"$ref":"#/components/schemas/UsersUserKeys"}}},"nextVersion":{"$ref":"#/components/schemas/Version"},"_expandable":{"type":"object","properties":{"lastUpdated":{"type":"string"},"previousVersion":{"type":"string"},"contributors":{"type":"string"},"nextVersion":{"type":"string"},"ownedBy":{"type":"string"},"lastOwnedBy":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentId":{"type":"string"},"ContentLookAndFeel":{"type":"object","properties":{"screen":{"$ref":"#/components/schemas/ScreenLookAndFeel"},"container":{"$ref":"#/components/schemas/ContainerLookAndFeel"},"header":{"$ref":"#/components/schemas/ContainerLookAndFeel"},"body":{"$ref":"#/components/schemas/ContainerLookAndFeel"}}},"ContentMetadata":{"type":"object","additionalProperties":true,"properties":{"currentuser":{"type":"object","properties":{"favourited":{"type":"object","properties":{"isFavourite":{"type":"boolean"},"favouritedDate":{"type":"string","format":"date-time"}}},"lastmodified":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/Version"},"friendlyLastModified":{"type":"string"}}},"lastcontributed":{"type":"object","properties":{"status":{"type":"string"},"when":{"type":"string","format":"date-time"}}},"viewed":{"type":"object","properties":{"lastSeen":{"type":"string","format":"date-time"},"friendlyLastSeen":{"type":"string"}}},"scheduled":{"type":"object"},"_expandable":{"type":"object","properties":{"favourited":{"type":"string"},"lastmodified":{"type":"string"},"lastcontributed":{"type":"string"},"viewed":{"type":"string"},"scheduled":{"type":"string"}}}}},"properties":{"$ref":"#/components/schemas/GenericLinks"},"frontend":{"type":"object","additionalProperties":true},"labels":{"oneOf":[{"$ref":"#/components/schemas/LabelArray"},{"type":"array","items":{"$ref":"#/components/schemas/Label"}}]}},"description":"Metadata object for page, blogpost, comment content"},"ContentProperty":{"required":["_links","id","key","value"],"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"key":{"type":"string"},"value":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}],"description":"The value of the content property. This can be empty or a complex object."},"version":{"required":["message","minorEdit","number","when"],"type":"object","additionalProperties":true,"properties":{"when":{"type":"string","format":"date-time"},"message":{"type":"string"},"number":{"type":"integer","format":"int32"},"minorEdit":{"type":"boolean"},"contentTypeModified":{"type":"boolean","description":"True if content type is modifed in this version (e.g. page to blog)"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"},"_expandable":{"type":"object","properties":{"content":{"type":"string"},"additionalProperties":{"type":"string"}}}}},"ContentPropertyArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentProperty"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentPropertyCreate":{"required":["key","value"],"type":"object","additionalProperties":true,"properties":{"key":{"maxLength":255,"type":"string","description":"The key of the new property."},"value":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}],"description":"The value of the content property. This can be empty or a complex object."}}},"ContentPropertyCreateNoKey":{"required":["value"],"type":"object","additionalProperties":true,"properties":{"value":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}],"description":"The value of the content property. This can be empty or a complex object."}}},"ContentPropertyUpdate":{"required":["value","version"],"type":"object","additionalProperties":true,"properties":{"value":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}],"description":"The value of the content property. This can be empty or a complex object."},"version":{"required":["number"],"type":"object","nullable":true,"additionalProperties":true,"properties":{"number":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The new version for the updated content property. Set this to the\ncurrent version number incremented by one. To get the current\nversion number, use 'Get content property' and retrieve\n`version.number`.","format":"int32"},"minorEdit":{"type":"boolean","description":"If `minorEdit` is set to 'true', no notification email or activity\nstream will be generated for the change.","default":true}},"description":"The version number of the property."}}},"ContentRestriction":{"required":["_expandable","_links","operation"],"type":"object","properties":{"operation":{"type":"string","enum":["administer","copy","create","delete","export","move","purge","purge_version","read","restore","update","use"]},"restrictions":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/UserArray"},"group":{"$ref":"#/components/schemas/GroupArray"},"_expandable":{"type":"object","properties":{"user":{"type":"string"},"group":{"type":"string"}}}}},"content":{"$ref":"#/components/schemas/Content"},"_expandable":{"type":"object","properties":{"restrictions":{"type":"string"},"content":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentRestrictionArray":{"required":["_links","limit","restrictionsHash","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentRestriction"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"restrictionsHash":{"type":"string","description":"This property is used by the UI to figure out whether a set of restrictions\nhas changed."},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentRestrictionUpdate":{"required":["operation","restrictions"],"type":"object","properties":{"operation":{"type":"string","description":"The restriction operation applied to content.","enum":["administer","copy","create","delete","export","move","purge","purge_version","read","restore","update","use"]},"restrictions":{"type":"object","properties":{"group":{"type":"array","description":"The groups that the restrictions will be applied to. This array must\nhave at least one item, otherwise it should be omitted. At least one of `name` or `id` is required,\nand `id` should be used where possible in advance of the `name` deprecation.","items":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Set to 'group'.","enum":["group"]},"name":{"type":"string","description":"The name of the group.","deprecated":true},"id":{"type":"string","description":"The id of the group."}},"description":"A group that the restriction will be applied to."}},"user":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/User"}},{"$ref":"#/components/schemas/UserArray"}]}},"description":"The users/groups that the restrictions will be applied to. At least one of\n`user` or `group` must be specified for this object."},"content":{"$ref":"#/components/schemas/Content"}}},"ContentRestrictionAddOrUpdateArray":{"oneOf":[{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentRestrictionUpdate"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"restrictionsHash":{"type":"string","description":"This property is used by the UI to figure out whether a set of restrictions\nhas changed."},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},{"type":"array","items":{"$ref":"#/components/schemas/ContentRestrictionUpdate"}}]},"AddContentRestriction":{"required":["operation","restrictions"],"type":"object","properties":{"operation":{"type":"string","description":"The restriction operation applied to content.","enum":["read","update"]},"restrictions":{"type":"object","properties":{"user":{"type":"array","description":"The users that the restrictions will be applied to. This array must\nhave at least one item, otherwise it should be omitted.","items":{"required":["accountId","type"],"type":"object","properties":{"type":{"type":"string","description":"Set to 'known'.","enum":["known","unknown","anonymous","user"]},"username":{"$ref":"#/components/schemas/GenericUserName"},"userKey":{"$ref":"#/components/schemas/GenericUserKey"},"accountId":{"$ref":"#/components/schemas/GenericAccountId"}},"description":"A user that the restriction will be applied to. Either the `username`\nor the `userKey` must be specified to identify the user."}},"group":{"type":"array","description":"The groups that the restrictions will be applied to. This array must\nhave at least one item, otherwise it should be omitted.","items":{"required":["name","type"],"type":"object","properties":{"type":{"type":"string","description":"Set to 'group'.","enum":["group"]},"name":{"type":"string","description":"The name of the group."}},"description":"A group that the restriction will be applied to."}}},"description":"The users/groups that the restrictions will be applied to. At least one of\n`user` or `group` must be specified for this object."}}},"AddContentRestrictionUpdateArray":{"type":"array","items":{"$ref":"#/components/schemas/AddContentRestriction"}},"BulkContentStateSetInput":{"type":"object","required":["ids","contentState"],"properties":{"ids":{"description":"maximum number of ids you can pass in is 300","type":"array","items":{"$ref":"#/components/schemas/ContentId"}},"contentState":{"$ref":"#/components/schemas/ContentStateInput"}}},"ContentPageResponse":{"required":["limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Content"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"}}},"ContentState":{"required":["id","name","color"],"type":"object","properties":{"id":{"type":"integer","description":"identifier of content state. If 0, 1, or 2, this is a default space state","format":"int64"},"name":{"type":"string","description":"name of content state."},"color":{"type":"string","description":"hex string representing color of state"}}},"ContentStateBulkSetTaskUpdate":{"required":["set","failed","success","percentage"],"properties":{"set":{"type":"array","items":{"$ref":"#/components/schemas/ContentId"}},"failed":{"type":"array","items":{"$ref":"#/components/schemas/ContentStateFailure"}},"percentage":{"type":"integer","format":"int64"},"message":{"type":"string"},"state":{"$ref":"#/components/schemas/ContentState"},"success":{"type":"boolean"}},"type":"object"},"ContentStateFailure":{"required":["contentId","failureReason"],"type":"object","properties":{"contentId":{"$ref":"#/components/schemas/ContentId"},"failureReason":{"type":"string"}},"description":"Object describing why a content state set failed"},"ContentStateInput":{"type":"object","properties":{"name":{"type":"string"},"color":{"description":"Color of state. Must be in 6 digit hex form (#FFFFFF). The default colors offered in the UI are:\n #ff7452 (red),\n #2684ff (blue),\n #ffc400 (yellow),\n #57d9a3 (green), and\n #8777d9 (purple)","type":"string"},"id":{"type":"integer","format":"int32"},"spaceKey":{"type":"string"}}},"ContentStateRestInput":{"type":"object","properties":{"name":{"type":"string","description":"Name of content state. Maximum 20 characters."},"color":{"type":"string","description":"Color of state. Must be in 6 digit hex form (#FFFFFF). The default colors offered in the UI are:\n #ff7452 (red),\n #2684ff (blue),\n #ffc400 (yellow),\n #57d9a3 (green), and\n #8777d9 (purple)"},"id":{"type":"integer","description":"id of state. This can be 0,1, or 2 if you wish to specify a default space state.","format":"int64"}}},"ContentStateResponse":{"type":"object","properties":{"contentState":{"$ref":"#/components/schemas/ContentState","description":"Null or content state"},"lastUpdated":{"type":"string","description":"Timestamp of last publish event where content state changed"}}},"ContentStateSettings":{"required":["contentStatesAllowed","customContentStatesAllowed","spaceContentStatesAllowed"],"type":"object","properties":{"contentStatesAllowed":{"type":"boolean","description":"Whether users can place any content states on content"},"customContentStatesAllowed":{"type":"boolean","description":"Whether users can place their custom states on content"},"spaceContentStatesAllowed":{"type":"boolean","description":"Whether users can place space suggested states on content"},"spaceContentStates":{"type":"array","items":{"$ref":"#/components/schemas/ContentState"},"description":"space suggested content states that users can choose from"}}},"ContentTemplate":{"required":["_links","description","labels","name","templateId","templateType"],"type":"object","properties":{"templateId":{"type":"string"},"originalTemplate":{"type":"object","properties":{"pluginKey":{"type":"string"},"moduleKey":{"type":"string"}}},"referencingBlueprint":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"space":{"type":"object","additionalProperties":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"templateType":{"type":"string"},"editorVersion":{"type":"string"},"body":{"$ref":"#/components/schemas/ContentTemplateBody"},"_expandable":{"type":"object","properties":{"body":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentTemplateArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentTemplate"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ContentTemplateCreate":{"required":["body","name","templateType"],"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"The name of the new template."},"templateType":{"type":"string","description":"The type of the new template. Set to `page`."},"body":{"$ref":"#/components/schemas/ContentTemplateBodyCreate"},"description":{"maxLength":255,"type":"string","description":"A description of the new template."},"labels":{"type":"array","description":"Labels for the new template.","items":{"$ref":"#/components/schemas/Label"}},"space":{"required":["key"],"type":"object","additionalProperties":true,"nullable":true,"properties":{"key":{"type":"string"}},"description":"The key for the space of the new template. Only applies to space templates.\nIf the spaceKey is not specified, the template will be created as a global\ntemplate."}},"description":"This object is used to create content templates."},"ContentTemplateBody":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/ContentBody"},"export_view":{"$ref":"#/components/schemas/ContentBody"},"styled_view":{"$ref":"#/components/schemas/ContentBody"},"storage":{"$ref":"#/components/schemas/ContentBody"},"editor":{"$ref":"#/components/schemas/ContentBody"},"editor2":{"$ref":"#/components/schemas/ContentBody"},"wiki":{"$ref":"#/components/schemas/ContentBody"},"atlas_doc_format":{"$ref":"#/components/schemas/ContentBody"},"anonymous_export_view":{"$ref":"#/components/schemas/ContentBody"}},"description":"The body of the new content. Does not apply to attachments.\nOnly one body format should be specified as the property for\nthis object, e.g. `storage`.\n\nNote, `editor2` format is used by Atlassian only. `anonymous_export_view` is\nthe same as `export_view` format but only content viewable by an anonymous\nuser is included."},"ContentTemplateBodyCreate":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/ContentBodyCreate"},"export_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"styled_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"storage":{"$ref":"#/components/schemas/ContentBodyCreate"},"editor":{"$ref":"#/components/schemas/ContentBodyCreate"},"editor2":{"$ref":"#/components/schemas/ContentBodyCreate"},"wiki":{"$ref":"#/components/schemas/ContentBodyCreate"},"atlas_doc_format":{"$ref":"#/components/schemas/ContentBodyCreate"},"anonymous_export_view":{"$ref":"#/components/schemas/ContentBodyCreate"}},"description":"The body of the new content. Does not apply to attachments.\nOnly one body format should be specified as the property for\nthis object, e.g. `storage`.\n\nNote, `editor2` format is used by Atlassian only. `anonymous_export_view` is\nthe same as `export_view` format but only content viewable by an anonymous\nuser is included."},"ContentTemplateUpdate":{"required":["body","name","templateId","templateType"],"type":"object","additionalProperties":true,"properties":{"templateId":{"type":"string","description":"The ID of the template being updated."},"name":{"type":"string","description":"The name of the template. Set to the current `name` if this field is\nnot being updated."},"templateType":{"type":"string","description":"The type of the template. Set to `page`.","enum":["page"]},"body":{"$ref":"#/components/schemas/ContentTemplateBodyCreate"},"description":{"maxLength":100,"type":"string","description":"A description of the template."},"labels":{"type":"array","description":"Labels for the template.","items":{"$ref":"#/components/schemas/Label"}},"space":{"required":["key"],"type":"object","additionalProperties":true,"nullable":true,"properties":{"key":{"type":"string"}},"description":"The key for the space of the template. Required if the template is a\nspace template. Set this to the current `space.key`."}},"description":"This object is used to update content templates."},"ContentUpdate":{"required":["type","version"],"type":"object","additionalProperties":true,"properties":{"version":{"nullable":true,"required":["number"],"type":"object","additionalProperties":true,"properties":{"number":{"type":"integer","description":"The version number.","format":"int32"},"message":{"type":"string","description":"An optional message to be stored with the corresponding version.","nullable":true}},"description":"The new version for the updated content. Set this to the current version number incremented by one, unless you are changing the status to 'draft' which must have a version number of 1.\n\nTo get the current version number, use [Get content by ID](#api-content-id-get) and retrieve `version.number`."},"title":{"nullable":true,"maxLength":255,"type":"string","description":"The updated title of the content. If you are updating a non-draft `page` or `blogpost`, title is required. If you are not changing the title, set this field to the the current title."},"type":{"nullable":true,"type":"string","description":"The type of content. Set this to the current type of the content. For example, - page - blogpost - comment - attachment"},"status":{"type":"string","description":"The updated status of the content. Note, if you change the status of a page from\n'current' to 'draft' and it has an existing draft, the existing draft will be deleted\nin favor of the updated page.","enum":["current","trashed","deleted","historical","draft"]},"ancestors":{"nullable":true,"type":"array","description":"The new parent for the content. Only one parent content 'id' can be specified.","items":{"required":["id"],"type":"object","additionalProperties":true,"properties":{"id":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The `id` of the parent content."}}}},"body":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/ContentBodyCreate"},"export_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"styled_view":{"$ref":"#/components/schemas/ContentBodyCreate"},"storage":{"$ref":"#/components/schemas/ContentBodyCreateStorage"},"editor":{"$ref":"#/components/schemas/ContentBodyCreate"},"editor2":{"$ref":"#/components/schemas/ContentBodyCreate"},"wiki":{"$ref":"#/components/schemas/ContentBodyCreate"},"atlas_doc_format":{"$ref":"#/components/schemas/ContentBodyCreate"},"anonymous_export_view":{"$ref":"#/components/schemas/ContentBodyCreate"}},"description":"The updated body of the content. Does not apply to attachments.\nIf you are not sure how to generate these formats, you can create a page in the\nConfluence application, retrieve the content using [Get content](#api-content-get),\nand expand the desired content format, e.g. `expand=body.storage`."}}},"CopyPageHierarchyRequest":{"required":["destinationPageId"],"type":"object","properties":{"copyAttachments":{"type":"boolean","description":"If set to `true`, attachments are copied to the destination page.","default":false},"copyPermissions":{"type":"boolean","description":"If set to `true`, page permissions are copied to the destination page.","default":false},"copyProperties":{"type":"boolean","description":"If set to `true`, content properties are copied to the destination page.","default":false},"copyLabels":{"type":"boolean","description":"If set to `true`, labels are copied to the destination page.","default":false},"copyCustomContents":{"type":"boolean","description":"If set to `true`, custom contents are copied to the destination page.","default":false},"copyDescendants":{"type":"boolean","description":"If set to `true`, descendants are copied to the destination page.","default":true},"destinationPageId":{"$ref":"#/components/schemas/ContentId"},"titleOptions":{"$ref":"#/components/schemas/CopyPageHierarchyTitleOptions"}}},"CopyPageHierarchyTitleOptions":{"type":"object","properties":{"prefix":{"type":"string"},"replace":{"type":"string"},"search":{"type":"string"}},"description":"Required for copying page in the same space."},"CopyPageRequest":{"required":["destination"],"type":"object","properties":{"copyAttachments":{"type":"boolean","description":"If set to `true`, attachments are copied to the destination page.","default":false},"copyPermissions":{"type":"boolean","description":"If set to `true`, page permissions are copied to the destination page.","default":false},"copyProperties":{"type":"boolean","description":"If set to `true`, content properties are copied to the destination page.","default":false},"copyLabels":{"type":"boolean","description":"If set to `true`, labels are copied to the destination page.","default":false},"copyCustomContents":{"type":"boolean","description":"If set to `true`, custom contents are copied to the destination page.","default":false},"destination":{"$ref":"#/components/schemas/CopyPageRequestDestination"},"pageTitle":{"type":"string","description":"If defined, this will replace the title of the destination page."},"body":{"type":"object","properties":{"storage":{"$ref":"#/components/schemas/ContentBodyCreate"},"editor2":{"$ref":"#/components/schemas/ContentBodyCreate"}},"description":"If defined, this will replace the body of the destination page."}}},"CopyPageRequestDestination":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["space","existing_page","parent_page"]},"value":{"type":"string","description":"The space key for `space` type, and content id for `parent_page` and `existing_page`"}},"description":"Defines where the page will be copied to, and can be one of the following types.\n\n - `parent_page`: page will be copied as a child of the specified parent page\n - `space`: page will be copied to the specified space as a root page on the space\n - `existing_page`: page will be copied and replace the specified page"},"CQLPersonalDataConvertedQueries":{"required":["queryStrings"],"type":"object","properties":{"queryStrings":{"type":"array","description":"The list of converted CQL query strings with account IDs in\nplace of user identifiers.","items":{"type":"string"}}},"description":"The converted CQL queries."},"CQLPersonalDataMigrationRequest":{"required":["queryStrings"],"type":"object","properties":{"queryStrings":{"type":"array","description":"A list of queries with user identifiers. Maximum of 100 queries.","example":["type = page and creator != admin and space = DEV"],"items":{"type":"string"}}},"description":"The CQL queries to be converted."},"DynamicModulesErrorMessage":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"The error message."}},"example":{"message":"The request is not from a Connect app."}},"Embeddable":{"type":"object","additionalProperties":true},"EmbeddedContent":{"type":"object","additionalProperties":true,"properties":{"entityId":{"type":"integer","format":"int64"},"entityType":{"type":"string"},"entity":{"$ref":"#/components/schemas/Embeddable"}}},"GenericAccountId":{"type":"string","nullable":true,"description":"The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."},"GenericLinks":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]}},"GenericUserName":{"type":"string","nullable":true,"description":"This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."},"GenericUserKey":{"type":"string","nullable":true,"description":"This property is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."},"GlobalSpaceIdentifier":{"type":"object","nullable":true,"required":["spaceIdentifier"],"properties":{"spaceIdentifier":{"type":"string"}}},"Group":{"required":["name","type","id"],"type":"object","properties":{"type":{"type":"string","default":"group","enum":["group"]},"name":{"type":"string"},"id":{"type":"string"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"GroupCreate":{"required":["type"],"type":"object","description":"The name property will soon be deprecated in favor of using id.","additionalProperties":true,"properties":{"type":{"type":"string","default":"group","enum":["group"]},"name":{"type":"string","deprecated":true},"id":{"type":"string"}}},"GroupArray":{"required":["limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"}}},"GroupArrayWithLinks":{"description":"Same as GroupArray but with `_links` property.","required":["limit","results","size","start","_links"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalSize":{"type":"integer","format":"int64","default":0,"description":"This property will return total count of the objects before pagination is applied.\nThis value is returned if `shouldReturnTotalSize` is set to `true`."},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"GroupName":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"HeaderLookAndFeel":{"required":["backgroundColor","button","primaryNavigation","search","secondaryNavigation"],"type":"object","properties":{"backgroundColor":{"type":"string"},"button":{"$ref":"#/components/schemas/ButtonLookAndFeel"},"primaryNavigation":{"$ref":"#/components/schemas/NavigationLookAndFeel"},"secondaryNavigation":{"$ref":"#/components/schemas/NavigationLookAndFeel"},"search":{"$ref":"#/components/schemas/SearchFieldLookAndFeel"}}},"HorizontalHeaderLookAndFeel":{"required":["backgroundColor","primaryNavigation"],"type":"object","properties":{"backgroundColor":{"type":"string"},"button":{"$ref":"#/components/schemas/ButtonLookAndFeel"},"primaryNavigation":{"$ref":"#/components/schemas/TopNavigationLookAndFeel"},"secondaryNavigation":{"$ref":"#/components/schemas/NavigationLookAndFeel"},"search":{"$ref":"#/components/schemas/SearchFieldLookAndFeel"}}},"Icon":{"required":["height","isDefault","path","width"],"type":"object","nullable":true,"properties":{"path":{"type":"string"},"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"isDefault":{"type":"boolean"}},"description":"This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting."},"Label":{"required":["id","label","name","prefix"],"type":"object","properties":{"prefix":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"}}},"LabelArray":{"required":["results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"LabeledContent":{"required":["contentId","contentType","title"],"type":"object","properties":{"contentType":{"$ref":"#/components/schemas/LabeledContentType"},"contentId":{"type":"integer","format":"int64"},"title":{"type":"string","description":"Title of the content."}}},"LabeledContentType":{"type":"string","enum":["page","blogpost","attachment","page_template"]},"LabeledContentPageResponse":{"required":["results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LabeledContent"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"}}},"LabelDetails":{"required":["label"],"type":"object","properties":{"label":{"$ref":"#/components/schemas/Label"},"associatedContents":{"$ref":"#/components/schemas/LabeledContentPageResponse"}}},"LabelCreate":{"required":["name","prefix"],"type":"object","additionalProperties":true,"properties":{"prefix":{"type":"string","description":"The prefix for the label. `global`, `my` `team`, etc."},"name":{"type":"string","description":"The name of the label, which will be shown in the UI."}}},"LabelCreateArray":{"type":"array","items":{"$ref":"#/components/schemas/LabelCreate"}},"LongTask":{"required":["id","links"],"type":"object","properties":{"ari":{"type":"string","description":"the ARI for the long task, based on its ID"},"id":{"type":"string","description":"a unique identifier for the long task"},"links":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"The URL to retrive status of long task."}}}}},"LookAndFeel":{"required":["bordersAndDividers","content","header","headings","links","menus"],"type":"object","properties":{"headings":{"required":["color"],"type":"object","properties":{"color":{"type":"string"}}},"links":{"required":["color"],"type":"object","properties":{"color":{"type":"string"}}},"menus":{"$ref":"#/components/schemas/MenusLookAndFeel"},"header":{"$ref":"#/components/schemas/HeaderLookAndFeel"},"horizontalHeader":{"$ref":"#/components/schemas/HorizontalHeaderLookAndFeel"},"content":{"$ref":"#/components/schemas/ContentLookAndFeel"},"bordersAndDividers":{"required":["color"],"type":"object","properties":{"color":{"type":"string"}}},"spaceReference":{"type":"object","nullable":true}}},"LookAndFeelWithLinks":{"description":"Look and feel settings returned after an update.","allOf":[{"$ref":"#/components/schemas/LookAndFeel"},{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/GenericLinks"}}}]},"LookAndFeelSelection":{"required":["lookAndFeelType","spaceKey"],"type":"object","properties":{"spaceKey":{"type":"string","description":"The key of the space for which the look and feel settings will be\nset."},"lookAndFeelType":{"type":"string","enum":["global","custom","theme"]}},"description":"Look and feel selection"},"LookAndFeelSettings":{"required":["custom","global","selected"],"type":"object","properties":{"selected":{"type":"string","enum":["global","custom"]},"global":{"$ref":"#/components/schemas/LookAndFeel"},"theme":{"$ref":"#/components/schemas/LookAndFeel"},"custom":{"$ref":"#/components/schemas/LookAndFeel"}}},"LongTaskStatus":{"required":["elapsedTime","finished","id","messages","name","percentageComplete","successful"],"type":"object","properties":{"ari":{"type":"string","description":"the ARI for the long task, based on its ID"},"id":{"type":"string"},"name":{"required":["args","key"],"type":"object","properties":{"key":{"type":"string"},"args":{"type":"array","items":{"type":"object","properties":{}}}}},"elapsedTime":{"type":"integer","format":"int64"},"percentageComplete":{"type":"integer","format":"int32"},"successful":{"type":"boolean"},"finished":{"type":"boolean"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"status":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"additionalDetails":{"type":"object","properties":{"destinationId":{"type":"string"},"destinationUrl":{"type":"string"},"totalPageNeedToCopy":{"type":"integer"},"additionalProperties":{"type":"string"}}}},"description":"Current status of a long running task\n\nStatus keys:\n\n- `ERROR_UNKNOWN` - Generic error\n- `ERROR_LOCK_FAILED` - Could not get the lock on destination space\n- `ERROR_RELINK` - Error when relink pages/attachments\n- `ERROR_COPY_PAGE` - Error while copying 1 page\n- `WARN_RENAME_PAGE` - Warning page is rename during copy\n- `WARN_IGNORE_COPY_PERMISSION` - Warning could not copy permission\n- `WARN_IGNORE_COPY_ATTACHMENT` - Warning could not copy attachment\n- `WARN_IGNORE_DELETE_PAGE` - Warning ignoring delete of a non agreed on page\n- `STATUS_COPIED_PAGES` - Message total pages are copied\n- `STATUS_COPYING_PAGES` - Message copy pages\n- `STATUS_RELINK_PAGES` - Message relink pages/attachments\n- `STATUS_DELETING_PAGES` - Message delete pages\n- `STATUS_DELETED_PAGES` - Message total pages are deleted\n- `STATUS_MOVING_PAGES` - Message move pages\n- `WARN_IGNORE_VIEW_RESTRICTED` - Permission changed - view restricted\n- `WARN_IGNORE_EDIT_RESTRICTED` - Permission changed - edit restricted\n- `INITIALIZING_TASK` - Message when initializing task\n- `UNKNOWN_STATUS` - Message when status is unknown"},"LongTaskStatusArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/LongTaskStatus"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"LongTaskStatusWithLinks":{"required":["_links","elapsedTime","finished","id","messages","name","percentageComplete","successful"],"type":"object","properties":{"ari":{"type":"string","description":"the ARI for the long task, based on its ID"},"id":{"type":"string"},"name":{"required":["args","key"],"type":"object","properties":{"key":{"type":"string"},"args":{"type":"array","items":{"type":"object","properties":{}}}}},"elapsedTime":{"type":"integer","format":"int64"},"percentageComplete":{"type":"integer","format":"int32"},"successful":{"type":"boolean"},"finished":{"type":"boolean"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"_links":{"$ref":"#/components/schemas/GenericLinks"},"status":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"additionalDetails":{"type":"object","properties":{"destinationId":{"type":"string","nullable":true},"destinationUrl":{"type":"string"},"totalPageNeedToCopy":{"type":"integer"},"additionalProperties":{"type":"string"}}}},"description":"Same as LongTaskStatus but with `_links` property.\n\nStatus keys:\n\n- `ERROR_UNKNOWN` - Generic error\n- `ERROR_LOCK_FAILED` - Could not get the lock on destination space\n- `ERROR_RELINK` - Error when relink pages/attachments\n- `ERROR_COPY_PAGE` - Error while copying 1 page\n- `WARN_RENAME_PAGE` - Warning page is rename during copy\n- `WARN_IGNORE_COPY_PERMISSION` - Warning could not copy permission\n- `WARN_IGNORE_COPY_ATTACHMENT` - Warning could not copy attachment\n- `WARN_IGNORE_DELETE_PAGE` - Warning ignoring delete of a non agreed on page\n- `STATUS_COPIED_PAGES` - Message total pages are copied\n- `STATUS_COPYING_PAGES` - Message copy pages\n- `STATUS_RELINK_PAGES` - Message relink pages/attachments\n- `STATUS_DELETING_PAGES` - Message delete pages\n- `STATUS_DELETED_PAGES` - Message total pages are deleted\n- `STATUS_MOVING_PAGES` - Message move pages\n- `WARN_IGNORE_VIEW_RESTRICTED` - Permission changed - view restricted\n- `WARN_IGNORE_EDIT_RESTRICTED` - Permission changed - edit restricted\n- `INITIALIZING_TASK` - Message when initializing task\n- `UNKNOWN_STATUS` - Message when status is unknown"},"MacroInstance":{"type":"object","properties":{"name":{"type":"string"},"body":{"type":"string"},"parameters":{"type":"object"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"MenusLookAndFeel":{"required":["color","hoverOrFocus"],"type":"object","properties":{"hoverOrFocus":{"required":["backgroundColor"],"type":"object","properties":{"backgroundColor":{"type":"string"}}},"color":{"type":"string"}}},"Message":{"required":["args"],"type":"object","additionalProperties":true,"properties":{"translation":{"type":"string"},"args":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}}}},"BulkUserLookup":{"required":["_expandable","_links","accountId","accountType","displayName","email","profilePicture","publicName","type"],"type":"object","properties":{"type":{"type":"string","enum":["known","unknown","anonymous","user"]},"username":{"$ref":"#/components/schemas/GenericUserName"},"userKey":{"$ref":"#/components/schemas/GenericUserKey"},"accountId":{"$ref":"#/components/schemas/GenericAccountId"},"accountType":{"type":"string","description":"The account type of the user, may return empty string if unavailable."},"email":{"type":"string","description":"The email address of the user. Depending on the user's privacy setting, this may return an empty string."},"publicName":{"type":"string","description":"The public name or nickname of the user. Will always contain a value."},"profilePicture":{"$ref":"#/components/schemas/Icon"},"displayName":{"type":"string","description":"The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName."},"timeZone":{"nullable":true,"type":"string","description":"This displays user time zone. Depending on the user's privacy setting, this may return null."},"isExternalCollaborator":{"type":"boolean","description":"Whether the user is an external collaborator user"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationCheckResult"}},"details":{"$ref":"#/components/schemas/UserDetails"},"personalSpace":{"$ref":"#/components/schemas/Space"},"_expandable":{"type":"object","properties":{"operations":{"type":"string"},"details":{"type":"string"},"personalSpace":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"BulkUserLookupArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BulkUserLookup"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"NavigationLookAndFeel":{"required":["color","hoverOrFocus"],"type":"object","nullable":true,"properties":{"color":{"type":"string"},"highlightColor":{"type":"string","nullable":true},"hoverOrFocus":{"required":["backgroundColor","color"],"type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}}}}},"TopNavigationLookAndFeel":{"required":["highlightColor"],"type":"object","properties":{"color":{"type":"string","nullable":true},"highlightColor":{"type":"string"},"hoverOrFocus":{"type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}}}}},"OperationCheckResult":{"required":["operation","targetType"],"type":"object","properties":{"operation":{"type":"string","description":"The operation itself.","enum":["administer","archive","clear_permissions","copy","create","create_space","delete","export","move","purge","purge_version","read","restore","restrict_content","update","use"]},"targetType":{"type":"string","description":"The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space"}},"description":"An operation and the target entity that it applies to, e.g. create page."},"PropertyValue":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}],"description":"The value of the property. This can be empty or a complex object. 64KB Size Limit\nFor example,\n```\n\"value\": {\n \"example1\": \"value\",\n \"example2\": true,\n \"example3\": 123,\n \"example4\": [\"value1\", \"value2\"],\n}\n```"},"Relation":{"required":["_links","name"],"type":"object","properties":{"name":{"type":"string"},"relationData":{"$ref":"#/components/schemas/RelationData"},"source":{"oneOf":[{"$ref":"#/components/schemas/Content"},{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/Space"}]},"target":{"oneOf":[{"$ref":"#/components/schemas/Content"},{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/Space"}]},"_expandable":{"type":"object","properties":{"relationData":{"type":"string"},"source":{"type":"string"},"target":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"RelationArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Relation"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"RelationData":{"type":"object","properties":{"createdBy":{"$ref":"#/components/schemas/User"},"createdDate":{"type":"string","format":"date-time"},"friendlyCreatedDate":{"type":"string"}}},"RetentionPeriod":{"required":["number","units"],"type":"object","properties":{"number":{"type":"integer","description":"The number of units for the retention period.","format":"int32"},"units":{"type":"string","description":"The unit of time that the retention period is measured in.","enum":["NANOS","MICROS","MILLIS","SECONDS","MINUTES","HOURS","HALF_DAYS","DAYS","WEEKS","MONTHS","YEARS","DECADES","CENTURIES","MILLENNIA","ERAS","FOREVER"]}}},"ScreenLookAndFeel":{"required":["background"],"type":"object","properties":{"background":{"type":"string"},"backgroundAttachment":{"type":"string","nullable":true},"backgroundBlendMode":{"type":"string","nullable":true},"backgroundClip":{"type":"string","nullable":true},"backgroundColor":{"type":"string","nullable":true},"backgroundImage":{"type":"string","nullable":true},"backgroundOrigin":{"type":"string","nullable":true},"backgroundPosition":{"type":"string","nullable":true},"backgroundRepeat":{"type":"string","nullable":true},"backgroundSize":{"type":"string","nullable":true},"layer":{"type":"object","properties":{"width":{"type":"string"},"height":{"type":"string"}},"nullable":true},"gutterTop":{"type":"string","nullable":true},"gutterRight":{"type":"string","nullable":true},"gutterBottom":{"type":"string","nullable":true},"gutterLeft":{"type":"string","nullable":true}}},"SearchFieldLookAndFeel":{"required":["backgroundColor","color"],"type":"object","nullable":true,"properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}}},"SearchPageResponseSearchResult":{"required":["_links","cqlQuery","limit","results","searchDuration","size","start","totalSize"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalSize":{"type":"integer","format":"int32"},"cqlQuery":{"type":"string"},"searchDuration":{"type":"integer","format":"int32"},"archivedResultCount":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"SearchResult":{"required":["breadcrumbs","entityType","excerpt","iconCssClass","lastModified","title","url"],"type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"user":{"$ref":"#/components/schemas/User"},"space":{"$ref":"#/components/schemas/Space"},"title":{"type":"string"},"excerpt":{"type":"string"},"url":{"type":"string"},"resultParentContainer":{"$ref":"#/components/schemas/ContainerSummary"},"resultGlobalContainer":{"$ref":"#/components/schemas/ContainerSummary"},"breadcrumbs":{"type":"array","items":{"$ref":"#/components/schemas/Breadcrumb"}},"entityType":{"type":"string"},"iconCssClass":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"friendlyLastModified":{"type":"string"},"score":{"type":"number"}}},"Space":{"required":["_expandable","_links","key","name","status","type"],"nullable":true,"type":"object","properties":{"id":{"type":"integer","format":"int64"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"$ref":"#/components/schemas/Icon"},"description":{"type":"object","properties":{"plain":{"$ref":"#/components/schemas/SpaceDescription"},"view":{"$ref":"#/components/schemas/SpaceDescription"},"_expandable":{"type":"object","properties":{"view":{"type":"string"},"plain":{"type":"string"}}}}},"homepage":{"$ref":"#/components/schemas/Content"},"type":{"type":"string"},"metadata":{"type":"object","properties":{"labels":{"$ref":"#/components/schemas/LabelArray"},"_expandable":{"type":"object"}}},"operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationCheckResult"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/SpacePermission"}},"status":{"type":"string"},"settings":{"$ref":"#/components/schemas/SpaceSettings"},"theme":{"$ref":"#/components/schemas/Theme"},"lookAndFeel":{"$ref":"#/components/schemas/LookAndFeel"},"history":{"required":["createdDate"],"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"createdBy":{"$ref":"#/components/schemas/User"}}},"_expandable":{"type":"object","properties":{"settings":{"type":"string"},"metadata":{"type":"string"},"operations":{"type":"string"},"lookAndFeel":{"type":"string"},"permissions":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"theme":{"type":"string"},"history":{"type":"string"},"homepage":{"type":"string"},"identifiers":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"SpaceArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Space"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"SpaceCreate":{"required":["key","name"],"type":"object","additionalProperties":true,"properties":{"key":{"type":"string","description":"The key for the new space. Format: See [Space\nkeys](https://confluence.atlassian.com/x/lqNMMQ)."},"name":{"maxLength":200,"type":"string","description":"The name of the new space."},"description":{"$ref":"#/components/schemas/SpaceDescriptionCreate"},"permissions":{"type":"array","nullable":true,"description":"The permissions for the new space. If no permissions are provided, the\n[Confluence default space permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions)\nare applied. Note that if permissions are provided, the space is\ncreated with only the provided set of permissions, not\nincluding the default space permissions. Space permissions\ncan be modified after creation using the space permissions\nendpoints, and a private space can be created using the\ncreate private space endpoint.","items":{"$ref":"#/components/schemas/SpacePermissionCreate"}}},"description":"This is the request object used when creating a new space."},"SpaceUpdate":{"type":"object","additionalProperties":true,"properties":{"name":{"nullable":true,"maxLength":200,"type":"string","description":"The updated name of the space."},"description":{"$ref":"#/components/schemas/SpaceDescriptionCreate"},"homepage":{"nullable":true,"description":"The updated homepage for this space","type":"object"},"type":{"description":"The updated type for this space.","type":"string"},"status":{"nullable":true,"description":"The updated status for this space.","type":"string"}},"description":"The properties of a space that can be updated."},"SpaceDescription":{"required":["embeddedContent","representation","value"],"type":"object","additionalProperties":true,"properties":{"value":{"type":"string"},"representation":{"type":"string","enum":["plain","view"]},"embeddedContent":{"type":"array","items":{"type":"object","properties":{}}}}},"SpaceDescriptionCreate":{"required":["plain"],"type":"object","nullable":true,"properties":{"plain":{"type":"object","additionalProperties":true,"properties":{"value":{"type":"string","description":"The space description."},"representation":{"type":"string","description":"Set to 'plain'."}}}},"description":"The description of the new/updated space. Note, only the 'plain' representation\ncan be used for the description when creating or updating a space."},"SpacePermission":{"required":["anonymousAccess","operation","unlicensedAccess"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"subjects":{"type":"object","properties":{"user":{"required":["results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"size":{"type":"integer","format":"int32"},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"}}},"group":{"required":["results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"size":{"type":"integer","format":"int32"},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"}}},"_expandable":{"type":"object","properties":{"user":{"type":"string"},"group":{"type":"string"}}}},"description":"The users and/or groups that the permission applies to."},"operation":{"$ref":"#/components/schemas/OperationCheckResult"},"anonymousAccess":{"type":"boolean","description":"Grant anonymous users permission to use the operation.","default":false},"unlicensedAccess":{"type":"boolean","description":"Grants access to unlicensed users from JIRA Service Desk when used\nwith the 'read space' operation.","default":false}},"description":"This object represents a permission for given space. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation` and `targetType` values are\nvalid for the `operation` object:\n\n - 'create': 'page', 'blogpost', 'comment', 'attachment'\n - 'read': 'space'\n - 'delete': 'page', 'blogpost', 'comment', 'attachment'\n - 'export': 'space'\n - 'administer': 'space'"},"SpacePermissionCreate":{"required":["anonymousAccess","operation","unlicensedAccess"],"type":"object","additionalProperties":true,"properties":{"subjects":{"type":"object","properties":{"user":{"required":["results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"size":{"type":"integer","format":"int32"}}},"group":{"required":["results","size"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/GroupCreate"}},"size":{"type":"integer","format":"int32"}}}},"description":"The users and/or groups that the permission applies to."},"operation":{"$ref":"#/components/schemas/OperationCheckResult"},"anonymousAccess":{"type":"boolean","description":"Grant anonymous users permission to use the operation.","default":false},"unlicensedAccess":{"type":"boolean","description":"Grants access to unlicensed users from JIRA Service Desk when used\nwith the 'read space' operation.","default":false}},"description":"This object represents a permission for given space. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation` and `targetType` values are\nvalid for the `operation` object:\n\n - 'create': 'page', 'blogpost', 'comment', 'attachment'\n - 'read': 'space'\n - 'delete': 'page', 'blogpost', 'comment', 'attachment'\n - 'export': 'space'\n - 'administer': 'space'"},"SpaceProperty":{"required":["_expandable","id","key","value"],"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"value":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}]},"version":{"$ref":"#/components/schemas/Version"},"space":{"$ref":"#/components/schemas/Space"},"_links":{"$ref":"#/components/schemas/GenericLinks"},"_expandable":{"type":"object","properties":{"version":{"type":"string"},"space":{"type":"string"}}}}},"SpacePropertyArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SpaceProperty"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"SpacePropertyCreate":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string","description":"The key of the new property."},"value":{"$ref":"#/components/schemas/PropertyValue"},"space":{"type":"object","additionalProperties":true,"properties":{"key":{"type":"string","description":"The key of the space"}}}}},"SpacePropertyCreateNoKey":{"required":["value"],"type":"object","properties":{"value":{"$ref":"#/components/schemas/PropertyValue"}}},"SpacePropertyUpdate":{"required":["value","version"],"type":"object","properties":{"key":{"type":"string"},"value":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"boolean"},{"type":"object","additionalProperties":true,"properties":{}},{"type":"string"}]},"version":{"$ref":"#/components/schemas/Version"},"space":{"type":"object","additionalProperties":true,"properties":{"key":{"type":"string","description":"The key of the space"}}}}},"SpaceSettings":{"nullable":true,"required":["_links","routeOverrideEnabled"],"type":"object","properties":{"routeOverrideEnabled":{"type":"boolean","description":"Defines whether an override for the space home should be used. This is\nused in conjunction with a space theme provided by an app. For\nexample, if this property is set to true, a theme can display a page\nother than the space homepage when users visit the root URL for a\nspace. This property allows apps to provide content-only theming\nwithout overriding the space home."},"editor":{"required":["page","blogpost","default"],"type":"object","properties":{"page":{"type":"string"},"blogpost":{"type":"string"},"default":{"type":"string"}}},"spaceKey":{"type":"string"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"SpaceSettingsUpdate":{"type":"object","properties":{"routeOverrideEnabled":{"type":"boolean","description":"Defines whether an override for the space home should be used. This is\nused in conjunction with a space theme provided by an app. For\nexample, if this property is set to true, a theme can display a page\nother than the space homepage when users visit the root URL for a\nspace. This property allows apps to provide content-only theming\nwithout overriding the space home."}}},"SpaceWatch":{"required":["type","watcher"],"type":"object","properties":{"type":{"type":"string"},"watcher":{"$ref":"#/components/schemas/WatchUser"},"spaceKey":{"type":"string"},"labelName":{"type":"string"},"prefix":{"type":"string"}}},"SpaceWatchArray":{"required":["limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SpaceWatch"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"SuperBatchWebResources":{"type":"object","properties":{"uris":{"type":"object","properties":{"all":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"css":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"js":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"tags":{"type":"object","properties":{"all":{"type":"string"},"css":{"type":"string"},"data":{"type":"string"},"js":{"type":"string"}}},"metatags":{"type":"string"},"_expandable":{"type":"object","additionalProperties":true}}},"SystemInfoEntity":{"required":["cloudId","commitHash"],"type":"object","nullable":true,"properties":{"cloudId":{"type":"string"},"commitHash":{"type":"string"},"baseUrl":{"type":"string"},"fallbackBaseUrl":{"type":"string"},"edition":{"type":"string"},"siteTitle":{"type":"string"},"defaultLocale":{"type":"string"},"defaultTimeZone":{"type":"string"},"microsPerimeter":{"type":"string"}}},"TaskStatusUpdate":{"required":["status"],"type":"object","properties":{"status":{"type":"string","enum":["complete","incomplete"]}}},"Task":{"required":["contentId","createDate","creator","globalId","id","status"],"type":"object","properties":{"globalId":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"contentId":{"type":"integer","format":"int64"},"status":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"body":{"type":"string"},"creator":{"type":"string"},"assignee":{"type":"string"},"completeUser":{"type":"string"},"createDate":{"type":"integer","format":"int64"},"dueDate":{"type":"integer","format":"int64"},"updateDate":{"type":"integer","format":"int64"},"completeDate":{"type":"integer","format":"int64"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"TaskPageResponse":{"required":["limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"}}},"Theme":{"required":["themeKey"],"type":"object","properties":{"themeKey":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"$ref":"#/components/schemas/Icon"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ThemeNoLinks":{"required":["themeKey"],"type":"object","properties":{"themeKey":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"$ref":"#/components/schemas/Icon"}},"description":"Theme object without links. Used in ThemeArray."},"ThemeArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ThemeNoLinks"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"ThemeUpdate":{"required":["themeKey"],"type":"object","properties":{"themeKey":{"type":"string","description":"The key of the theme to be set as the space theme."}}},"User":{"required":["type"],"type":"object","additionalProperties":true,"nullable":true,"properties":{"type":{"type":"string","enum":["known","unknown","anonymous","user"]},"username":{"$ref":"#/components/schemas/GenericUserName"},"userKey":{"$ref":"#/components/schemas/GenericUserKey"},"accountId":{"$ref":"#/components/schemas/GenericAccountId"},"accountType":{"type":"string","description":"The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.","enum":["atlassian","app",""]},"email":{"nullable":true,"type":"string","description":"The email address of the user. Depending on the user's privacy setting, this may return an empty string."},"publicName":{"type":"string","description":"The public name or nickname of the user. Will always contain a value."},"profilePicture":{"$ref":"#/components/schemas/Icon"},"displayName":{"nullable":true,"type":"string","description":"The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName."},"timeZone":{"nullable":true,"type":"string","description":"This displays user time zone. Depending on the user's privacy setting, this may return null."},"isExternalCollaborator":{"type":"boolean","description":"Whether the user is an external collaborator user"},"externalCollaborator":{"type":"boolean","description":"Whether the user is an external collaborator user"},"operations":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/OperationCheckResult"}},"details":{"$ref":"#/components/schemas/UserDetails"},"personalSpace":{"$ref":"#/components/schemas/Space"},"_expandable":{"type":"object","properties":{"operations":{"type":"string"},"details":{"type":"string"},"personalSpace":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"UserAnonymous":{"required":["_links","displayName","profilePicture","type"],"type":"object","properties":{"type":{"type":"string"},"profilePicture":{"$ref":"#/components/schemas/Icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationCheckResult"}},"isExternalCollaborator":{"type":"boolean","description":"Whether the user is an external collaborator user"},"_expandable":{"type":"object","properties":{"operations":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"UserArray":{"required":["results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalSize":{"type":"integer","format":"int64","default":0,"description":"This property will return total count of the objects before pagination is applied.\nThis value is returned if `shouldReturnTotalSize` is set to `true`."},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"UserDetails":{"type":"object","properties":{"business":{"type":"object","properties":{"position":{"type":"string","description":"This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."},"department":{"type":"string","description":"This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."},"location":{"type":"string","description":"This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."}}},"personal":{"type":"object","properties":{"phone":{"type":"string","description":"This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."},"im":{"type":"string","description":"This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."},"website":{"type":"string","description":"This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."},"email":{"type":"string","description":"This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."}}}}},"UserProperty":{"required":["key","value","id","lastModifiedDate","createdDate"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"object","additionalProperties":true,"properties":{},"description":"The value of the content property."},"id":{"type":"string","description":"a unique identifier for the user property"},"lastModifiedDate":{"type":"string","format":"date-time","description":"datetime when the property was last modified such as `2022-02-01T12:00:00.111Z`"},"createdDate":{"type":"string","format":"date-time","description":"datetime when the property was created such as `2022-01-01T12:00:00.111Z`"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"UserPropertyKeyArray":{"required":["results"],"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"}}}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"UserPropertyCreate":{"required":["value"],"type":"object","additionalProperties":false,"properties":{"value":{"type":"object","additionalProperties":true,"properties":{},"description":"The value of the user property."}}},"UserPropertyUpdate":{"required":["value"],"type":"object","additionalProperties":false,"properties":{"value":{"type":"object","additionalProperties":true,"properties":{},"description":"The value of the user property."}}},"UsersUserKeys":{"required":["userAccountIds"],"nullable":true,"type":"object","additionalProperties":true,"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"userKeys":{"type":"array","items":{"type":"string"}},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"UserWatch":{"required":["watching"],"type":"object","properties":{"watching":{"type":"boolean"}}},"Version":{"required":["minorEdit","number","when"],"type":"object","nullable":true,"additionalProperties":true,"properties":{"by":{"$ref":"#/components/schemas/User"},"when":{"type":"string","format":"date-time","nullable":true},"friendlyWhen":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"number":{"type":"integer","format":"int32","description":"Set this to the current version number incremented by one"},"minorEdit":{"description":"If `minorEdit` is set to 'true', no notification email or activity\nstream will be generated for the change.","type":"boolean"},"content":{"$ref":"#/components/schemas/Content"},"collaborators":{"$ref":"#/components/schemas/UsersUserKeys"},"_expandable":{"type":"object","properties":{"content":{"type":"string"},"collaborators":{"type":"string"}}},"_links":{"$ref":"#/components/schemas/GenericLinks"},"contentTypeModified":{"type":"boolean","description":"True if content type is modifed in this version (e.g. page to blog)"},"confRev":{"type":"string","nullable":true,"description":"The revision id provided by confluence to be used as a revision in Synchrony"},"syncRev":{"type":"string","nullable":true,"description":"The revision id provided by Synchrony"},"syncRevSource":{"type":"string","nullable":true,"description":"Source of the synchrony revision"}}},"VersionArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Version"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"VersionRestore":{"required":["operationKey","params"],"type":"object","properties":{"operationKey":{"type":"string","description":"Set to 'restore'.","enum":["restore"]},"params":{"required":["message","versionNumber"],"type":"object","properties":{"versionNumber":{"type":"integer","description":"The version number to be restored.","format":"int32"},"message":{"type":"string","description":"Description for the version."},"restoreTitle":{"type":"boolean","default":false,"description":"If true, the content title will be the same as the title from the version restored. Defaults to `false`."}}}}},"Watch":{"required":["contentId","type","watcher"],"type":"object","properties":{"type":{"type":"string"},"watcher":{"$ref":"#/components/schemas/WatchUser"},"contentId":{"type":"integer","format":"int64"}}},"WatchArray":{"required":["_links","limit","results","size","start"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Watch"}},"start":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"_links":{"$ref":"#/components/schemas/GenericLinks"}}},"WatchUser":{"required":["type","accountId","profilePicture","displayName","operations","isExternalCollaborator","accountType","email","publicName","personalSpace","externalCollaborator"],"type":"object","properties":{"type":{"type":"string"},"username":{"$ref":"#/components/schemas/GenericUserName"},"userKey":{"$ref":"#/components/schemas/GenericUserKey"},"accountId":{"$ref":"#/components/schemas/GenericAccountId"},"profilePicture":{"$ref":"#/components/schemas/Icon"},"displayName":{"type":"string"},"timeZone":{"nullable":true,"type":"string"},"operations":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/OperationCheckResult"}},"isExternalCollaborator":{"type":"boolean"},"details":{"$ref":"#/components/schemas/UserDetails"},"accountType":{"type":"string"},"email":{"type":"string"},"publicName":{"type":"string"},"personalSpace":{"type":"object","nullable":true},"externalCollaborator":{"type":"boolean"}},"description":"This essentially the same as the `User` object, but no `_links` property and\nno `_expandable` property (therefore, different required fields)."},"WebResourceDependencies":{"type":"object","properties":{"_expandable":{"type":"object","additionalProperties":true,"properties":{"uris":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}}},"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","properties":{"all":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"css":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"js":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"_expandable":{"type":"object","additionalProperties":true,"properties":{"css":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"js":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}}}},"tags":{"type":"object","properties":{"all":{"type":"string"},"css":{"type":"string"},"data":{"type":"string"},"js":{"type":"string"},"_expandable":{"type":"object","additionalProperties":true}}},"superbatch":{"$ref":"#/components/schemas/SuperBatchWebResources"}}},"PermissionSubject":{"required":["identifier","type"],"type":"object","properties":{"type":{"type":"string","enum":["user","group"]},"identifier":{"type":"string","description":"for `type=user`, identifier should be user's accountId or `anonymous` for anonymous users\n\nfor `type=group`, identifier should be the groupId. We are deprecating groupName support in mid-2024 \nfor this field but still accept it in the interim."}},"description":"The user or group that the permission applies to."},"PermissionSubjectWithGroupId":{"required":["identifier","type"],"type":"object","properties":{"type":{"type":"string","enum":["user","group"]},"identifier":{"type":"string","description":"for `type=user`, identifier should be user's accountId or `anonymous` for anonymous users\n\nfor `type=group`, identifier should be ID of the group"}},"description":"The user or group that the permission applies to."},"SpacePermissionV2":{"required":["id","subject","operation"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"subject":{"$ref":"#/components/schemas/PermissionSubject"},"operation":{"required":["key","target"],"type":"object","properties":{"key":{"type":"string","enum":["administer","archive","copy","create","delete","export","move","purge","purge_version","read","restore","restrict_content","update","use"]},"target":{"type":"string","description":"The space or content type that the operation applies to.","enum":["page","blogpost","comment","attachment","space"]}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}},"description":"This object represents a single space permission. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation.key` and `operation.target` values are\nvalid for the `operation` object:\n``` bash\n'create': 'page', 'blogpost', 'comment', 'attachment'\n'read': 'space'\n'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'\n'export': 'space'\n'administer': 'space'\n'archive': 'page'\n'restrict_content': 'space'\n```\n\nFor example, to enable Delete Own permission, set the `operation` object to the following:\n```\n\"operation\": {\n \"key\": \"delete\",\n \"target\": \"space\"\n}\n```\nTo enable Add/Delete Restrictions permissions, set the `operation` object to the following:\n```\n\"operation\": {\n \"key\": \"restrict_content\",\n \"target\": \"space\"\n}\n```"},"SpacePermissionRequest":{"required":["subject","operation"],"type":"object","additionalProperties":true,"properties":{"subject":{"$ref":"#/components/schemas/PermissionSubject"},"operation":{"required":["key","target"],"type":"object","properties":{"key":{"type":"string","enum":["administer","archive","copy","create","delete","export","move","purge","purge_version","read","restore","restrict_content","update","use"]},"target":{"type":"string","description":"The space or content type that the operation applies to.","enum":["page","blogpost","comment","attachment","space"]}}},"_links":{"$ref":"#/components/schemas/GenericLinks"}},"description":"This object represents the request for the single space permission. Permissions consist of\none operation object with an accompanying subjects object.\n\nThe following combinations of `operation.key` and `operation.target` values are\nvalid for the `operation` object:\n``` bash\n'create': 'page', 'blogpost', 'comment', 'attachment'\n'read': 'space'\n'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'\n'export': 'space'\n'administer': 'space'\n'archive': 'page'\n'restrict_content': 'space'\n```\n\nFor example, to enable Delete Own permission, set the `operation` object to the following:\n```\n\"operation\": {\n \"key\": \"delete\",\n \"target\": \"space\"\n}\n```\nTo enable Add/Delete Restrictions permissions, set the `operation` object to the following:\n```\n\"operation\": {\n \"key\": \"restrict_content\",\n \"target\": \"space\"\n}\n```"},"SpacePermissionCustomContent":{"required":["operations","subject"],"type":"object","properties":{"subject":{"$ref":"#/components/schemas/PermissionSubject"},"operations":{"type":"array","items":{"required":["access","key","target"],"type":"object","properties":{"key":{"type":"string","description":"The operation type","enum":["read","create","delete"]},"target":{"type":"string","description":"The custom content type"},"access":{"type":"boolean","description":"Grant or restrict access"}}}}},"description":"This object represents a list of space permissions for custom content type for an individual user. Permissions consist of\na subjects object and a list with at least one operation object."},"ContentPermissionRequest":{"required":["operation","subject"],"type":"object","properties":{"subject":{"$ref":"#/components/schemas/PermissionSubjectWithGroupId"},"operation":{"type":"string","description":"The content permission operation to check.","enum":["read","update","delete"]}},"description":"This object represents the request for the content permission check API."},"PermissionCheckResponse":{"required":["hasPermission"],"type":"object","properties":{"hasPermission":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"_links":{"$ref":"#/components/schemas/GenericLinks"}},"description":"This object represents the response for the content permission check API. If the user or group does not have\npermissions, the following errors may be returned:\n\n- Group does not have permission to the space\n- Group does not have permission to the content\n- User is not allowed to use Confluence\n- User does not have permission to the space\n- User does not have permission to the content\n- Anonymous users are not allowed to use Confluence\n- Anonymous user does not have permission to the space\n- Anonymous user does not have permission to the content"}},"parameters":{"contentExpand":{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},"bodyConversionExpand":{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the\n`to` conversion format and may be irrelevant for certain conversions (e.g. `macroRenderedOutput` is redundant when\nconverting to `view` format). \n\nIf rendering to `view` format, and the body content being converted includes arbitrary nested content (such as macros); then it is \nnecessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for\nany nested dynamic content (i.e. macros).\n\n- `embeddedContent` returns metadata for nested content (e.g. page included using page include macro)\n- `mediaToken` returns JWT token for retrieving attachment data from Media API\n- `macroRenderedOutput` additionally converts body to view format\n- `webresource.superbatch.uris.js` returns all common JS dependencies as static URLs\n- `webresource.superbatch.uris.css` returns all common CSS dependencies as static URLs\n- `webresource.superbatch.uris.all` returns all common dependencies as static URLs\n- `webresource.superbatch.tags.all` returns all common JS dependencies as html `