lamplighter-mcp
Version:
An intelligent context engine for AI-assisted software development
1 lines • 570 kB
JSON
{"openapi":"3.0.3","info":{"title":"The Confluence Cloud REST API v2","description":"This document describes Confluence's v2 APIs. This is intended to be an iteration on the existing Confluence Cloud REST API with improvements in both endpoint definitions and performance.","termsOfService":"https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/","version":"2.0.0"},"externalDocs":{"description":"The online and complete version of the Confluence Cloud REST API docs.","url":"https://developer.atlassian.com/cloud/confluence/rest/v2"},"servers":[{"url":"https://{your-domain}/wiki/api/v2","variables":{"your-domain":{"default":"no-default","description":"Specific domain of the Confluence site being used. Must be provided."}}}],"tags":[{"name":"Admin Key","description":"The [Admin Key feature](https://support.atlassian.com/confluence-cloud/docs/bypass-access-restrictions-on-a-page-with-admin-key/) is only offered with Confluence Cloud Premium and Enterprise to organization or site admins."},{"name":"Attachment","description":""},{"name":"Ancestors","description":""},{"name":"Blog Post","description":""},{"name":"Children","description":""},{"name":"Classification Level","description":""},{"name":"Comment","description":""},{"name":"Content","description":""},{"name":"Content Properties","description":""},{"name":"Custom Content","description":""},{"name":"Database","description":""},{"name":"Data Policies","description":""},{"name":"Descendants","description":""},{"name":"Folder","description":""},{"name":"Label","description":""},{"name":"Like","description":""},{"name":"Operation","description":""},{"name":"Page","description":""},{"name":"Smart Link","description":""},{"name":"Space","description":""},{"name":"Space Permissions","description":""},{"name":"Space Properties","description":""},{"name":"Space Roles","description":""},{"name":"Task","description":""},{"name":"User","description":""},{"name":"Version","description":""},{"name":"Whiteboard","description":""}],"paths":{"/admin-key":{"get":{"tags":["Admin Key"],"operationId":"getAdminKey","summary":"Get Admin Key","description":"Returns information about the admin key if one is currently enabled for the calling user within the site.\n\n**[Permissions](https://support.atlassian.com/user-management/docs/give-users-admin-permissions/#Centralized-user-management-content) required**:\nUser must be an organization or site admin.","responses":{"200":{"description":"Returned if an admin key is currently enabled for the calling user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminKeyResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"404":{"description":"Returned if the calling user does not currently have an admin key, if the calling user does not have permission to use admin keys, or if the site is not a Confluence Cloud Premium or Enterprise instance.","content":{}}},"x-atlassian-connect-scope":"INACCESSIBLE"},"post":{"tags":["Admin Key"],"operationId":"enableAdminKey","summary":"Enable Admin Key","description":"Enables admin key access for the calling user within the site. If an admin key already exists for the user, a new one will be issued with an updated expiration time.\n\n**Note:** The `durationInMinutes` field within the request body is optional. If the request body is empty or if the `durationInMinutes` is set to 0 minutes, a new admin key will be issued to the calling user with a default duration of 10 minutes.\n\n**[Permissions](https://support.atlassian.com/user-management/docs/give-users-admin-permissions/#Centralized-user-management-content) required**:\nUser must be an organization or site admin.","requestBody":{"$ref":"#/components/requestBodies/AdminKeyRequest"},"responses":{"200":{"description":"Returned if a new admin key is successfully issued for the calling user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminKeyResponse"}}}},"400":{"description":"Returned if the request body contains an invalid `durationInMinutes`.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to use admin keys or if the site is not a Confluence Cloud Premium or Enterprise instance.","content":{}}},"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Admin Key"],"operationId":"disableAdminKey","summary":"Disable Admin Key","description":"Disables admin key access for the calling user within the site.\n\n**[Permissions](https://support.atlassian.com/user-management/docs/give-users-admin-permissions/#Centralized-user-management-content) required**:\nUser must be an organization or site admin.","responses":{"204":{"description":"Returned if admin key access was successfully disabled for the calling user or if the user did not have an admin key in the first place.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to use admin keys or if the site is not a Confluence Cloud Premium or Enterprise instance.","content":{}}},"x-atlassian-connect-scope":"INACCESSIBLE"}},"/attachments":{"get":{"tags":["Attachment"],"operationId":"getAttachments","summary":"Get attachments","description":"Returns all attachments. The number of results is limited by the `limit` parameter and additional results (if available)\nwill be available through the `next` URL present in the `Link` response header.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the container of the attachment.","parameters":[{"name":"sort","in":"query","required":false,"description":"Used to sort the result by a particular field.","schema":{"$ref":"#/components/schemas/AttachmentSortOrder"}},{"name":"cursor","in":"query","required":false,"description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Filter the results to attachments based on their status. By default, `current` and `archived` are used.","schema":{"type":"array","items":{"type":"string","enum":["current","archived","trashed"]}}},{"name":"mediaType","in":"query","required":false,"description":"Filters on the mediaType of attachments. Only one may be specified.","schema":{"type":"string"}},{"name":"filename","in":"query","required":false,"description":"Filters on the file-name of attachments. Only one may be specified.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.","schema":{"format":"int32","default":50,"minimum":1,"maximum":250,"type":"integer"}}],"responses":{"200":{"description":"Returned if the requested attachments are returned.","content":{"application/json":{"schema":{"title":"MultiEntityResult<Attachment>","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentBulk"}},"_links":{"$ref":"#/components/schemas/MultiEntityLinks"}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request's URL. For example, rel=\"next\" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/attachments?cursor=<opaque cursor token>>; rel=\"next\", <https://site.atlassian.net/wiki>; rel=\"base\"`\n"}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{id}":{"get":{"tags":["Attachment"],"operationId":"getAttachmentById","summary":"Get attachment by id","description":"Returns a specific attachment.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the attachment's container.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content.","schema":{"type":"string","pattern":"(att)?[0-9]+"}},{"name":"version","in":"query","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.","schema":{"type":"integer"}},{"name":"include-labels","in":"query","description":"Includes labels associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-properties","in":"query","description":"Includes content properties associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-operations","in":"query","description":"Includes operations associated with this attachment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-versions","in":"query","description":"Includes versions associated with this attachment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-version","in":"query","description":"Includes the current version associated with this attachment in the response.\nBy default this is included and can be omitted by setting the value to `false`.","schema":{"type":"boolean","default":true}},{"name":"include-collaborators","in":"query","description":"Includes collaborators on the attachment.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the requested attachment is returned.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AttachmentSingle"},{"type":"object","properties":{"_links":{"type":"object","properties":{"base":{"type":"string","description":"Base url of the Confluence site."}}}}}]}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nrequested attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"delete":{"tags":["Attachment"],"operationId":"deleteAttachment","summary":"Delete attachment","description":"Delete an attachment by id.\n\nDeleting an attachment moves the attachment to the trash, where it can be restored later. To permanently delete an attachment (or \"purge\" it),\nthe endpoint must be called on a **trashed** attachment with the following param `purge=true`.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the container of the attachment.\nPermission to delete attachments in the space.\nPermission to administer the space (if attempting to purge).","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the attachment to be deleted.","schema":{"format":"int64","type":"integer"}},{"name":"purge","in":"query","required":false,"description":"If attempting to purge the attachment.","schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"Returned if the attachment was successfully deleted.","content":{}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if:\n- The provided attachment does not exist\n- The user does not have permissions to view the container of the attachment\n- The user does not have the needed permissions to delete an attachment in the space"}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["delete:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["delete:attachment:confluence"]}],"x-atlassian-connect-scope":"DELETE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{id}/labels":{"get":{"tags":["Label"],"operationId":"getAttachmentLabels","summary":"Get labels for attachment","description":"Returns the labels of specific attachment. The number of results is limited by the `limit` parameter and additional results (if available)\nwill be available through the `next` URL present in the `Link` response header.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the parent content of the attachment and its corresponding space.\nOnly labels that the user has permission to view will be returned.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the attachment for which labels should be returned.","schema":{"format":"int64","type":"integer"}},{"name":"prefix","in":"query","required":false,"description":"Filter the results to labels based on their prefix.","schema":{"type":"string","enum":["my","team","global","system"]}},{"name":"sort","in":"query","required":false,"description":"Used to sort the result by a particular field.","schema":{"type":"string","items":{"$ref":"#/components/schemas/LabelSortOrder"}}},{"name":"cursor","in":"query","required":false,"description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.","schema":{"format":"int32","default":25,"minimum":1,"maximum":250,"type":"integer"}}],"responses":{"200":{"description":"Returned if the requested labels are returned.","content":{"application/json":{"schema":{"title":"MultiEntityResult<Label>","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"_links":{"$ref":"#/components/schemas/MultiEntityLinks"}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request's URL. For example, rel=\"next\" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/attachments/<id>/labels?cursor=<opaque cursor token>>; rel=\"next\", <https://site.atlassian.net/wiki>; rel=\"base\"`\n"}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nparent content of the requested attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{id}/operations":{"get":{"tags":["Operation"],"operationId":"getAttachmentOperations","summary":"Get permitted operations for attachment","description":"Returns the permitted operations on specific attachment.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the parent content of the attachment and its corresponding space.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the attachment for which operations should be returned.","schema":{"type":"string","pattern":"(att)?[0-9]+"}}],"responses":{"200":{"description":"Returned if the requested operations are returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermittedOperationsResponse"}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nparent content of the requested attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{attachment-id}/properties":{"get":{"tags":["Content Properties"],"operationId":"getAttachmentContentProperties","summary":"Get content properties for attachment","description":"Retrieves all Content Properties tied to a specified attachment.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the attachment.","parameters":[{"name":"attachment-id","in":"path","required":true,"description":"The ID of the attachment for which content properties should be returned.","schema":{"type":"string","pattern":"(att)?[0-9]+"}},{"name":"key","in":"query","required":false,"description":"Filters the response to return a specific content property with matching key (case sensitive).","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the result by a particular field.","schema":{"$ref":"#/components/schemas/ContentPropertySortOrder"}},{"name":"cursor","in":"query","required":false,"description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.","schema":{"format":"int32","default":25,"minimum":1,"maximum":250,"type":"integer"}}],"responses":{"200":{"description":"Returned if the requested content properties are successfully retrieved.","content":{"application/json":{"schema":{"title":"MultiEntityResult<ContentProperty>","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentProperty"}},"_links":{"$ref":"#/components/schemas/MultiEntityLinks"}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request's URL. For example, rel=\"next\" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/attachments/<attachment-id>/properties?cursor=<opaque cursor token>>; rel=\"next\", <https://site.atlassian.net/wiki>; rel=\"base\"`\n"}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nspecified attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"post":{"tags":["Content Properties"],"operationId":"createAttachmentProperty","summary":"Create content property for attachment","description":"Creates a new content property for an attachment.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to update the attachment.","parameters":[{"name":"attachment-id","in":"path","required":true,"description":"The ID of the attachment to create a property for.","schema":{"type":"string","pattern":"(att)?[0-9]+"}}],"requestBody":{"description":"The content property to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPropertyCreateRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the content property was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nspecified attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence","write:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence","write:attachment:confluence"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{attachment-id}/properties/{property-id}":{"get":{"tags":["Content Properties"],"operationId":"getAttachmentContentPropertiesById","summary":"Get content property for attachment by id","description":"Retrieves a specific Content Property by ID that is attached to a specified attachment.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the attachment.","parameters":[{"name":"attachment-id","in":"path","required":true,"description":"The ID of the attachment for which content properties should be returned.","schema":{"pattern":"(att)?0-9+","type":"string"}},{"name":"property-id","in":"path","required":true,"description":"The ID of the content property to be returned","schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"Returned if the requested content property is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nspecified attachment,the attachment was not found, or the property was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"put":{"tags":["Content Properties"],"operationId":"updateAttachmentPropertyById","summary":"Update content property for attachment by id","description":"Update a content property for attachment by its id. \n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to edit the attachment.","parameters":[{"name":"attachment-id","in":"path","required":true,"description":"The ID of the attachment the property belongs to.","schema":{"type":"string","pattern":"(att)?[0-9]+"}},{"name":"property-id","in":"path","required":true,"description":"The ID of the property to be updated.","schema":{"format":"int64","type":"integer"}}],"requestBody":{"description":"The content property to be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPropertyUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the content property was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentProperty"}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nspecified attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence","write:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence","write:attachment:confluence"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"delete":{"tags":["Content Properties"],"operationId":"deleteAttachmentPropertyById","summary":"Delete content property for attachment by id","description":"Deletes a content property for an attachment by its id. \n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to attachment the page.","parameters":[{"name":"attachment-id","in":"path","required":true,"description":"The ID of the attachment the property belongs to.","schema":{"type":"string","pattern":"(att)?[0-9]+"}},{"name":"property-id","in":"path","required":true,"description":"The ID of the property to be deleted.","schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"Returned if the content property was deleted successfully."},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nspecified attachment or the attachment was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence","write:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence","write:attachment:confluence"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{id}/versions":{"get":{"tags":["Version"],"operationId":"getAttachmentVersions","summary":"Get attachment versions","description":"Returns the versions of specific attachment.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the attachment and its corresponding space.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the attachment to be queried for its versions. If you don't know the attachment ID, use Get attachments and filter the results.","schema":{"type":"string","pattern":"(att)?[0-9]+"}},{"name":"cursor","in":"query","required":false,"description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of versions per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.","schema":{"format":"int32","default":25,"minimum":1,"maximum":250,"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the result by a particular field.","schema":{"$ref":"#/components/schemas/VersionSortOrder"}}],"responses":{"200":{"description":"Returned if the requested attachment versions are returned.","content":{"application/json":{"schema":{"title":"MultiEntityResult<Version>","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentVersion"}},"_links":{"$ref":"#/components/schemas/MultiEntityLinks"}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request's URL. For example, rel=\"next\" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/attachments/<id>/versions?cursor=<opaque cursor token>>; rel=\"next\", <https://site.atlassian.net/wiki>; rel=\"base\"`\n"}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nrequested page or the page was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{attachment-id}/versions/{version-number}":{"get":{"tags":["Version"],"operationId":"getAttachmentVersionDetails","summary":"Get version details for attachment version","description":"Retrieves version details for the specified attachment and version number.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the attachment.","parameters":[{"name":"attachment-id","in":"path","required":true,"description":"The ID of the attachment for which version details should be returned.","schema":{"pattern":"(att)?0-9+","type":"string"}},{"name":"version-number","in":"path","required":true,"description":"The version number of the attachment to be returned.","schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"Returned if the requested version details are successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedVersion"}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nspecified attachment, the attachment was not found, or the version number does not exist.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:attachment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:attachment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/attachments/{id}/footer-comments":{"get":{"tags":["Comment"],"operationId":"getAttachmentComments","summary":"Get attachment comments","description":"Returns the comments of the specific attachment.\nThe number of results is limited by the `limit` parameter and additional results (if available) will be available through\nthe `next` URL present in the `Link` response header.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the attachment and its corresponding containers.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the attachment for which comments should be returned.","schema":{"type":"string","pattern":"(att)?[0-9]+"}},{"name":"body-format","in":"query","required":false,"description":"The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.","schema":{"$ref":"#/components/schemas/PrimaryBodyRepresentation"}},{"name":"cursor","in":"query","required":false,"description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.","schema":{"format":"int32","default":25,"minimum":1,"maximum":250,"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the result by a particular field.","schema":{"$ref":"#/components/schemas/CommentSortOrder"}},{"name":"version","in":"query","required":false,"description":"Version number of the attachment to retrieve comments for. If no version provided, retrieves comments for the latest version.","schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"Returned if the attachment comments were successfully retrieved","content":{"application/json":{"schema":{"title":"MultiEntityResult<AttachmentCommentModel>","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentCommentModel"}},"_links":{"$ref":"#/components/schemas/MultiEntityLinks"}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request's URL. For example, rel=\"next\" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/attachments/<id>/comments?cursor=<opaque cursor token>>; rel=\"next\", <https://site.atlassian.net/wiki>; rel=\"base\"`\n"}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nattachment or associated containers.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:comment:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:comment:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/blogposts":{"get":{"tags":["Blog Post"],"operationId":"getBlogPosts","summary":"Get blog posts","description":"Returns all blog posts. The number of results is limited by the `limit` parameter and additional results (if available)\nwill be available through the `next` URL present in the `Link` response header.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission).\nOnly blog posts that the user has permission to view will be returned.","parameters":[{"name":"id","in":"query","required":false,"description":"Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list.","schema":{"type":"array","maxItems":250,"items":{"type":"integer","format":"int64"}}},{"name":"space-id","in":"query","required":false,"description":"Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.","schema":{"type":"array","maxItems":100,"items":{"type":"integer","format":"int64"}}},{"name":"sort","in":"query","required":false,"description":"Used to sort the result by a particular field.","schema":{"$ref":"#/components/schemas/BlogPostSortOrder"}},{"name":"status","in":"query","required":false,"description":"Filter the results to blog posts based on their status. By default, `current` is used.","schema":{"type":"array","items":{"type":"string","enum":["current","deleted","trashed"]}}},{"name":"title","in":"query","required":false,"description":"Filter the results to blog posts based on their title.","schema":{"type":"string"}},{"name":"body-format","in":"query","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.","schema":{"$ref":"#/components/schemas/PrimaryBodyRepresentation"}},{"name":"cursor","in":"query","required":false,"description":"Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of blog posts per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results.","schema":{"format":"int32","default":25,"minimum":1,"maximum":250,"type":"integer"}}],"responses":{"200":{"description":"Returned if the requested blog posts are returned.","content":{"application/json":{"schema":{"title":"MultiEntityResult<BlogPost>","type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/BlogPostBulk"}},"_links":{"$ref":"#/components/schemas/MultiEntityLinks"}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request's URL. For example, rel=\"next\" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/blogposts?cursor=<opaque cursor token>>; rel=\"next\", <https://site.atlassian.net/wiki>; rel=\"base\"`\n"}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:page:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:page:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"post":{"tags":["Blog Post"],"operationId":"createBlogPost","summary":"Create blog post","description":"Creates a new blog post in the space specified by the spaceId.\n\nBy default this will create the blog post as a non-draft, unless the status is specified as draft.\nIf creating a non-draft, the title must not be empty.\n\nCurrently only supports the storage representation specified in the body.representation enums below","parameters":[{"name":"private","in":"query","description":"The blog post will be private. Only the user who creates this blog post will have permission to view and edit one.","schema":{"type":"boolean","default":false}}],"requestBody":{"$ref":"#/components/requestBodies/BlogPostCreateRequest"},"responses":{"200":{"description":"Returned if the blog post was created successfully.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BlogPostSingle"},{"type":"object","properties":{"_links":{"type":"object","properties":{"base":{"type":"string","description":"Base url of the Confluence site."}}}}}]}}}},"400":{"description":"Returned if invalid values were passed in for any of the enums, a REQUIRED parameter was missing, or if the given title is a duplicate in the space","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing from the request","content":{}},"404":{"description":"Returned if:\n- The provided space does not exist\n- The user does not have permissions to view the space\n- The user does not have the needed permissions to create a blog post in the provided space","content":{}},"413":{"description":"Returned if the request is too large in size (over 5 MB)","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:page:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:page:confluence"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]}},"/blogposts/{id}":{"get":{"tags":["Blog Post"],"operationId":"getBlogPostById","summary":"Get blog post by id","description":"Returns a specific blog post.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the blog post and its corresponding space.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the blog post to be returned. If you don't know the blog post ID, use Get blog posts and filter the results.","schema":{"format":"int64","type":"integer"}},{"name":"body-format","in":"query","description":"The content format types to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.","schema":{"$ref":"#/components/schemas/PrimaryBodyRepresentationSingle"}},{"name":"get-draft","in":"query","description":"Retrieve the draft version of this blog post.","schema":{"type":"boolean","default":false}},{"name":"status","in":"query","description":"Filter the blog post being retrieved by its status.","schema":{"type":"array","items":{"type":"string","enum":["current","trashed","deleted","historical","draft"]}}},{"name":"version","in":"query","description":"Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.","schema":{"type":"integer"}},{"name":"include-labels","in":"query","description":"Includes labels associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-properties","in":"query","description":"Includes content properties associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-operations","in":"query","description":"Includes operations associated with this blog post in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-likes","in":"query","description":"Includes likes associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-versions","in":"query","description":"Includes versions associated with this blog post in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.","schema":{"type":"boolean","default":false}},{"name":"include-version","in":"query","description":"Includes the current version associated with this blog post in the response.\nBy default this is included and can be omitted by setting the value to `false`.","schema":{"type":"boolean","default":true}},{"name":"include-favorited-by-current-user-status","in":"query","description":"Includes whether this blog post has been favorited by the current user.","schema":{"type":"boolean","default":false}},{"name":"include-webresources","in":"query","description":"Includes web resources that can be used to render blog post content on a client.","schema":{"type":"boolean","default":false}},{"name":"include-collaborators","in":"query","description":"Includes collaborators on the blog post.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returned if the requested blog post is returned.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BlogPostSingle"},{"type":"object","properties":{"_links":{"type":"object","properties":{"base":{"type":"string","description":"Base url of the Confluence site."}}}}}]}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if the calling user does not have permission to view the\nrequested blog post or the blog post was not found.","content":{}}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["read:page:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["read:page:confluence"]}],"x-atlassian-connect-scope":"READ","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"put":{"tags":["Blog Post"],"operationId":"updateBlogPost","summary":"Update blog post","description":"Update a blog post by id.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the blog post and its corresponding space. Permission to update blog posts in the space.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the blog post to be updated. If you don't know the blog post ID, use Get Blog Posts and filter the results.","schema":{"format":"int64","type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/BlogPostUpdateRequest"},"responses":{"200":{"description":"Returned if the requested blog post is successfully updated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BlogPostSingle"},{"type":"object","properties":{"_links":{"type":"object","properties":{"base":{"type":"string","description":"Base url of the Confluence site."}}}}}]}}}},"400":{"description":"Returned if an invalid request is provided.","content":{}},"401":{"description":"Returned if the authentication credentials are incorrect or missing\nfrom the request.","content":{}},"404":{"description":"Returned if:\n- The provided blog post does not exist\n- The user does not have permissions to view the blog post\n- The user does not have the needed permissions to update a blog post in the space"}},"security":[{"basicAuth":[]},{"oAuthDefinitions":["write:page:confluence"]}],"x-atlassian-oauth2-scopes":[{"scheme":"oAuthDefinitions","state":"Current","scopes":["write:page:confluence"]}],"x-atlassian-connect-scope":"WRITE","x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}]},"delete":{"tags":["Blog Post"],"operationId":"deleteBlogPost","summary":"Delete blog post","description":"Delete a blog post by id.\n\nBy default this will delete blog posts that are non-drafts. To delete a blog post that is a draft, the endpoint must be called on a \ndraft with the following param `draft=true`. Discarded drafts are not sent to the trash and are permanently deleted.\n\nDeleting a blog post that is not a draft moves the blog post to the trash, where it can be restored later.\nTo permanently delete a blog post (or \"purge\" it), the endpoint must be called on a **trashed** blog post with the following param `purge=true`.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to view the blog post and its corresponding space.\nPermission to delete blog posts in the space.\nPermission to administer the space (if attempting to purge).","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the b