openapi: 3.2.0
info:
  title: Confluence Cloud REST API v2 Content Properties API
  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
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: Content Properties
  description: ''
paths:
  /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.


        **Permissions required**:

        Permission 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"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified 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.


        **Permissions required**:

        Permission 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified 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.


        **Permissions required**:

        Permission 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified 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.


        **Permissions required**:

        Permission 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified 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.


        **Permissions required**:

        Permission 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified 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
  /blogposts/{blogpost-id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getBlogpostContentProperties
      summary: Get content properties for blog post
      description: 'Retrieves all Content Properties tied to a specified blog post.


        **Permissions required**:

        Permission to view the blog post.'
      parameters:
      - name: blogpost-id
        in: path
        required: true
        description: The ID of the blog post for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/blogposts/<blogpost-id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified 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
    post:
      tags:
      - Content Properties
      operationId: createBlogpostProperty
      summary: Create content property for blog post
      description: 'Creates a new property for a blogpost.


        **Permissions required**:

        Permission to update the blog post.'
      parameters:
      - name: blogpost-id
        in: path
        required: true
        description: The ID of the blog post to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified blog post or the blog post was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /blogposts/{blogpost-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getBlogpostContentPropertiesById
      summary: Get content property for blog post by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified blog post.


        **Permissions required**:

        Permission to view the blog post.'
      parameters:
      - name: blogpost-id
        in: path
        required: true
        description: The ID of the blog post for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the property being requested
        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'
          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/<blogpost-id>/properties/<property-id>?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified blog post,the blog post was not found, or the property 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:
      - Content Properties
      operationId: updateBlogpostPropertyById
      summary: Update content property for blog post by id
      description: 'Update a content property for blog post by its id.


        **Permissions required**:

        Permission to edit the blog post.'
      parameters:
      - name: blogpost-id
        in: path
        required: true
        description: The ID of the blog post the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified blog post or the blog post was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteBlogpostPropertyById
      summary: Delete content property for blogpost by id
      description: 'Deletes a content property for a blogpost by its id.


        **Permissions required**:

        Permission to edit the blog post.'
      parameters:
      - name: blogpost-id
        in: path
        required: true
        description: The ID of the blog post the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified blog post or the blog post was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /custom-content/{custom-content-id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getCustomContentContentProperties
      summary: Get content properties for custom content
      description: 'Retrieves Content Properties tied to a specified custom content.


        **Permissions required**:

        Permission to view the custom content.'
      parameters:
      - name: custom-content-id
        in: path
        required: true
        description: The ID of the custom content for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/custom-content/<custom-content-id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified custom content or the custom content was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:custom-content:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:custom-content:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    post:
      tags:
      - Content Properties
      operationId: createCustomContentProperty
      summary: Create content property for custom content
      description: 'Creates a new content property for a piece of custom content.


        **Permissions required**:

        Permission to update the custom content.'
      parameters:
      - name: custom-content-id
        in: path
        required: true
        description: The ID of the custom content to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified custom content or the custom content was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:custom-content:confluence
        - write:custom-content:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:custom-content:confluence
        - write:custom-content:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /custom-content/{custom-content-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getCustomContentContentPropertiesById
      summary: Get content property for custom content by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified custom content.


        **Permissions required**:

        Permission to view the page.'
      parameters:
      - name: custom-content-id
        in: path
        required: true
        description: The ID of the custom content for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified custom content, the custom content was not found, or the property was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:custom-content:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:custom-content:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    put:
      tags:
      - Content Properties
      operationId: updateCustomContentPropertyById
      summary: Update content property for custom content by id
      description: 'Update a content property for a piece of custom content by its id.


        **Permissions required**:

        Permission to edit the custom content.'
      parameters:
      - name: custom-content-id
        in: path
        required: true
        description: The ID of the custom content the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified custom content or the custom content was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:custom-content:confluence
        - write:custom-content:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:custom-content:confluence
        - write:custom-content:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteCustomContentPropertyById
      summary: Delete content property for custom content by id
      description: 'Deletes a content property for a piece of custom content by its id.


        **Permissions required**:

        Permission to edit the custom content.'
      parameters:
      - name: custom-content-id
        in: path
        required: true
        description: The ID of the custom content the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified custom content or the custom content was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:custom-content:confluence
        - write:custom-content:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:custom-content:confluence
        - write:custom-content:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /pages/{page-id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getPageContentProperties
      summary: Get content properties for page
      description: 'Retrieves Content Properties tied to a specified page.


        **Permissions required**:

        Permission to view the page.'
      parameters:
      - name: page-id
        in: path
        required: true
        description: The ID of the page for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/pages/<page-id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified page or the page 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
    post:
      tags:
      - Content Properties
      operationId: createPageProperty
      summary: Create content property for page
      description: 'Creates a new content property for a page.


        **Permissions required**:

        Permission to update the page.'
      parameters:
      - name: page-id
        in: path
        required: true
        description: The ID of the page to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified page or the page was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /pages/{page-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getPageContentPropertiesById
      summary: Get content property for page by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified page.


        **Permissions required**:

        Permission to view the page.'
      parameters:
      - name: page-id
        in: path
        required: true
        description: The ID of the page for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified page, the page was not found, or the property 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:
      - Content Properties
      operationId: updatePagePropertyById
      summary: Update content property for page by id
      description: 'Update a content property for a page by its id.


        **Permissions required**:

        Permission to edit the page.'
      parameters:
      - name: page-id
        in: path
        required: true
        description: The ID of the page the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified page or the page was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deletePagePropertyById
      summary: Delete content property for page by id
      description: 'Deletes a content property for a page by its id.


        **Permissions required**:

        Permission to edit the page.'
      parameters:
      - name: page-id
        in: path
        required: true
        description: The ID of the page the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified page or the page was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
        - write:page:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /whiteboards/{id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getWhiteboardContentProperties
      summary: Get content properties for whiteboard
      description: 'Retrieves Content Properties tied to a specified whiteboard.


        **Permissions required**:

        Permission to view the whiteboard.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the whiteboard for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/whiteboards/<id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified whiteboard or the whiteboard was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:whiteboard:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:whiteboard:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    post:
      tags:
      - Content Properties
      operationId: createWhiteboardProperty
      summary: Create content property for whiteboard
      description: 'Creates a new content property for a whiteboard.


        **Permissions required**:

        Permission to update the whiteboard.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the whiteboard to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified whiteboard or the whiteboard was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:whiteboard:confluence
        - write:whiteboard:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:whiteboard:confluence
        - write:whiteboard:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /whiteboards/{whiteboard-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getWhiteboardContentPropertiesById
      summary: Get content property for whiteboard by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified whiteboard.


        **Permissions required**:

        Permission to view the whiteboard.'
      parameters:
      - name: whiteboard-id
        in: path
        required: true
        description: The ID of the whiteboard for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified whiteboard, the whiteboard was not found, or the property was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:whiteboard:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:whiteboard:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    put:
      tags:
      - Content Properties
      operationId: updateWhiteboardPropertyById
      summary: Update content property for whiteboard by id
      description: 'Update a content property for a whiteboard by its id.


        **Permissions required**:

        Permission to edit the whiteboard.'
      parameters:
      - name: whiteboard-id
        in: path
        required: true
        description: The ID of the whiteboard the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified whiteboard or the whiteboard was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:whiteboard:confluence
        - write:whiteboard:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:whiteboard:confluence
        - write:whiteboard:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteWhiteboardPropertyById
      summary: Delete content property for whiteboard by id
      description: 'Deletes a content property for a whiteboard by its id.


        **Permissions required**:

        Permission to edit the whiteboard.'
      parameters:
      - name: whiteboard-id
        in: path
        required: true
        description: The ID of the whiteboard the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified whiteboard or the whiteboard was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:whiteboard:confluence
        - write:whiteboard:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:whiteboard:confluence
        - write:whiteboard:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /databases/{id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getDatabaseContentProperties
      summary: Get content properties for database
      description: 'Retrieves Content Properties tied to a specified database.


        **Permissions required**:

        Permission to view the database.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the database for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/databases/<id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified database or the database was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:database:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:database:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    post:
      tags:
      - Content Properties
      operationId: createDatabaseProperty
      summary: Create content property for database
      description: 'Creates a new content property for a database.


        **Permissions required**:

        Permission to update the database.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the database to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified database or the database was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:database:confluence
        - write:database:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:database:confluence
        - write:database:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /databases/{database-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getDatabaseContentPropertiesById
      summary: Get content property for database by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified database.


        **Permissions required**:

        Permission to view the database.'
      parameters:
      - name: database-id
        in: path
        required: true
        description: The ID of the database for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified database, the database was not found, or the property was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:database:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:database:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    put:
      tags:
      - Content Properties
      operationId: updateDatabasePropertyById
      summary: Update content property for database by id
      description: 'Update a content property for a database by its id.


        **Permissions required**:

        Permission to edit the database.'
      parameters:
      - name: database-id
        in: path
        required: true
        description: The ID of the database the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified database or the database was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:database:confluence
        - write:database:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:database:confluence
        - write:database:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteDatabasePropertyById
      summary: Delete content property for database by id
      description: 'Deletes a content property for a database by its id.


        **Permissions required**:

        Permission to edit the database.'
      parameters:
      - name: database-id
        in: path
        required: true
        description: The ID of the database the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified database or the database was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:database:confluence
        - write:database:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:database:confluence
        - write:database:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /embeds/{id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getSmartLinkContentProperties
      summary: Get content properties for Smart Link in the content tree
      description: 'Retrieves Content Properties tied to a specified Smart Link in the content tree.


        **Permissions required**:

        Permission to view the Smart Link in the content tree.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the Smart Link in the content tree for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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 Smart Links 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/embeds/<id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified Smart Link in the content tree or the Smart Link was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:embed:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:embed:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    post:
      tags:
      - Content Properties
      operationId: createSmartLinkProperty
      summary: Create content property for Smart Link in the content tree
      description: 'Creates a new content property for a Smart Link in the content tree.


        **Permissions required**:

        Permission to update the Smart Link in the content tree.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the Smart Link in the content tree to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified Smart Link in the content tree or the Smart Link was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:embed:confluence
        - write:embed:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:embed:confluence
        - write:embed:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /embeds/{embed-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getSmartLinkContentPropertiesById
      summary: Get content property for Smart Link in the content tree by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified Smart Link in the content tree.


        **Permissions required**:

        Permission to view the Smart Link in the content tree.'
      parameters:
      - name: embed-id
        in: path
        required: true
        description: The ID of the Smart Link in the content tree for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified Smart Link in the content tree, the Smart Link was not found, or the property was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:embed:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:embed:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    put:
      tags:
      - Content Properties
      operationId: updateSmartLinkPropertyById
      summary: Update content property for Smart Link in the content tree by id
      description: 'Update a content property for a Smart Link in the content tree by its id.


        **Permissions required**:

        Permission to edit the Smart Link in the content tree.'
      parameters:
      - name: embed-id
        in: path
        required: true
        description: The ID of the Smart Link in the content tree the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified Smart Link in the content tree or the Smart Link was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:embed:confluence
        - write:embed:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:embed:confluence
        - write:embed:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteSmartLinkPropertyById
      summary: Delete content property for Smart Link in the content tree by id
      description: 'Deletes a content property for a Smart Link in the content tree by its id.


        **Permissions required**:

        Permission to edit the Smart Link in the content tree.'
      parameters:
      - name: embed-id
        in: path
        required: true
        description: The ID of the Smart Link in the content tree the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified Smart Link in the content tree or the Smart Link was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:embed:confluence
        - write:embed:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:embed:confluence
        - write:embed:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /folders/{id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getFolderContentProperties
      summary: Get content properties for folder
      description: 'Retrieves Content Properties tied to a specified folder.


        **Permissions required**:

        Permission to view the folder.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the folder for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/embeds/<id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified folder or the folder was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:folder:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:folder:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    post:
      tags:
      - Content Properties
      operationId: createFolderProperty
      summary: Create content property for folder
      description: 'Creates a new content property for a folder.


        **Permissions required**:

        Permission to update the folder.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the folder to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified folder or the folder was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:folder:confluence
        - write:folder:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:folder:confluence
        - write:folder:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /folders/{folder-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getFolderContentPropertiesById
      summary: Get content property for folder by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified folder.


        **Permissions required**:

        Permission to view the folder.'
      parameters:
      - name: folder-id
        in: path
        required: true
        description: The ID of the folder for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified folder, the folder was not found, or the property was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:folder:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:folder:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    put:
      tags:
      - Content Properties
      operationId: updateFolderPropertyById
      summary: Update content property for folder by id
      description: 'Update a content property for a folder by its id.


        **Permissions required**:

        Permission to edit the folder.'
      parameters:
      - name: folder-id
        in: path
        required: true
        description: The ID of the folder the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified folder or the folder was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:folder:confluence
        - write:folder:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:folder:confluence
        - write:folder:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteFolderPropertyById
      summary: Delete content property for folder by id
      description: 'Deletes a content property for a folder by its id.


        **Permissions required**:

        Permission to edit the folder.'
      parameters:
      - name: folder-id
        in: path
        required: true
        description: The ID of the folder the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified folder or the folder was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:folder:confluence
        - write:folder:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:folder:confluence
        - write:folder:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /comments/{comment-id}/properties:
    get:
      tags:
      - Content Properties
      operationId: getCommentContentProperties
      summary: Get content properties for comment
      description: 'Retrieves Content Properties attached to a specified comment.


        **Permissions required**:

        Permission to view the comment.'
      parameters:
      - name: comment-id
        in: path
        required: true
        description: The ID of the comment for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - 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/comments/<comment-id>/properties?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          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 view the

            specified comment or the comment was not found.'
          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
    post:
      tags:
      - Content Properties
      operationId: createCommentProperty
      summary: Create content property for comment
      description: 'Creates a new content property for a comment.


        **Permissions required**:

        Permission to update the comment.'
      parameters:
      - name: comment-id
        in: path
        required: true
        description: The ID of the comment to create a property for.
        schema:
          format: int64
          type: integer
      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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified page or the page was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
        - write:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
        - write:comment:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /comments/{comment-id}/properties/{property-id}:
    get:
      tags:
      - Content Properties
      operationId: getCommentContentPropertiesById
      summary: Get content property for comment by id
      description: 'Retrieves a specific Content Property by ID that is attached to a specified comment.


        **Permissions required**:

        Permission to view the comment.'
      parameters:
      - name: comment-id
        in: path
        required: true
        description: The ID of the comment for which content properties should be returned.
        schema:
          format: int64
          type: integer
      - name: property-id
        in: path
        required: true
        description: The ID of the content property being requested.
        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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified comment, the comment was not found, or the property was not found.'
          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
    put:
      tags:
      - Content Properties
      operationId: updateCommentPropertyById
      summary: Update content property for comment by id
      description: 'Update a content property for a comment by its id.


        **Permissions required**:

        Permission to edit the comment.'
      parameters:
      - name: comment-id
        in: path
        required: true
        description: The ID of the comment the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified comment or the comment was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
        - write:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
        - write:comment:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
    delete:
      tags:
      - Content Properties
      operationId: deleteCommentPropertyById
      summary: Delete content property for comment by id
      description: 'Deletes a content property for a comment by its id.


        **Permissions required**:

        Permission to edit the comment.'
      parameters:
      - name: comment-id
        in: path
        required: true
        description: The ID of the comment the property belongs to.
        schema:
          format: int64
          type: integer
      - 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

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            specified comment or the comment was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
        - write:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
        - write:comment:confluence
      x-atlassian-connect-scope: WRITE
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
components:
  schemas:
    ContentProperty:
      type: object
      properties:
        id:
          type: string
          description: ID of the property
        key:
          type: string
          description: Key of the property
        value:
          description: Value of the property. Must be a valid JSON value.
        version:
          $ref: '#/components/schemas/Version'
    ContentPropertySortOrder:
      type: string
      description: The sort fields for content properties. The default sort direction is ascending. To sort in descending order, append a `-` character before the sort field. For example, `fieldName` or `-fieldName`.
      enum:
      - key
      - -key
    Version:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
        message:
          type: string
          description: Message associated with the current version.
        number:
          format: int32
          type: integer
          description: The version number.
        minorEdit:
          type: boolean
          description: Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
        authorId:
          type: string
          description: The account ID of the user who created this version.
    ContentPropertyCreateRequest:
      type: object
      properties:
        key:
          type: string
          description: Key of the content property
        value:
          description: Value of the content property.
    ContentPropertyUpdateRequest:
      type: object
      properties:
        key:
          type: string
          description: Key of the content property
        value:
          description: Value of the content property.
        version:
          type: object
          description: New version number and associated message
          properties:
            number:
              type: integer
              format: int32
              description: Version number of the new version. Should be 1 more than the current version number.
            message:
              type: string
              description: Message to be associated with the new version.
    MultiEntityLinks:
      type: object
      properties:
        next:
          type: string
          description: 'Used for pagination. Contains the relative URL for the next set of results, using a cursor query parameter.

            This property will not be present if there is no additional data available.'
        base:
          type: string
          description: Base url of the Confluence site.
  securitySchemes:
    basicAuth:
      type: http
      description: You can access this resource via basic auth.
      scheme: basic
    oAuthDefinitions:
      type: oauth2
      description: This API uses OAuth 2 with the authorizationCode grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          tokenUrl: https://auth.atlassian.com/oauth/token
          scopes:
            read:page:confluence: View pages and blogposts and their properties.
            read:space:confluence: View spaces and their properties.
            read:attachment:confluence: View attachments and their properties.
            read:comment:confluence: View comments and their properties.
            read:custom-content:confluence: View custom content and their properties.
            read:task:confluence: View tasks.
            read:whiteboard:confluence: View whiteboards and their properties.
            read:database:confluence: View databases and their properties.
            read:embed:confluence: View Smart Links in the content tree and their properties.
            read:folder:confluence: View folders and their properties.
            read:hierarchical-content:confluence: View children and descendants in the content tree.
            write:space:confluence: Create and update spaces and their properties.
            write:page:confluence: Create and update pages and blog posts and their properties.
            write:comment:confluence: Create and update comments and their properties.
            write:custom-content:confluence: Create and update custom content and their properties.
            write:whiteboard:confluence: Create and update whiteboards and their properties.
            write:database:confluence: Create and update databases and their properties.
            write:embed:confluence: Create and update Smart Links in the content tree and their properties.
            write:folder:confluence: Create and update folders and their properties.
            write:app-data:confluence: Create, update and delete app properties.
            delete:custom-content:confluence: Delete custom content.
            delete:page:confluence: Delete pages and blog posts.
            delete:comment:confluence: Delete comments.
            delete:whiteboard:confluence: Delete whiteboards.
            delete:database:confluence: Delete databases.
            delete:embed:confluence: Delete Smart Links in the content tree.
            delete:folder:confluence: Delete folders.
externalDocs:
  description: The online and complete version of the Confluence Cloud REST API docs.
  url: https://developer.atlassian.com/cloud/confluence/rest/v2
x-atlassian-narrative:
  documents:
  - title: About
    anchor: about
    body: This is the reference for the Confluence Cloud REST API v2, with definitions and performance intended to be an improvement over v1. You can click on the meatball menu in the upper right to download the spec or Postman collection.
  - title: Authentication and authorization
    anchor: auth
    body: '**Authentication:** If you are building a Cloud app, authentication is implemented via JWT or Oauth 2.0, depending on what you''re building (see [Authentication for apps](https://developer.atlassian.com/cloud/confluence/authentication-for-apps/)). Otherwise, if you are authenticating directly against the REST API, the REST API supports basic auth (see [Basic auth for REST APIs](https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/)).


      **Authorization:** If you are building a Cloud app, authorization can be implemented by [scopes](https://developer.atlassian.com/cloud/confluence/scopes/) or by [OAuth 2.0 user impersonation](https://developer.atlassian.com/cloud/confluence/oauth-2-jwt-bearer-tokens-for-apps). Otherwise, if you are making calls directly against the REST API, authorization is based on the user used in the authentication process.


      See [Security overview](https://developer.atlassian.com/cloud/confluence/security-overview/) for more details on authentication and authorization.'
  - title: Using the REST API
    anchor: using
    body: "**Pagination:** The Confluence REST API v2 uses cursor-based pagination: a method that returns a response with multiple objects can only return a limited number at one time. This limits the size of responses and conserves server resources.\n\nUse the 'limit' and 'cursor' parameters on endpoints that return multiple objects to work with pagination. First, make a request with your desired limit in the 'limit' parameter, then observe the `Link` header in the response. If there are additional entities to be retrieved, the `next` URL in the `Link` header will allow you to retrieve the next set of results. This relative URL will also be available under the `_links.next` property of paginated responses. \n\nFor example, the following request will return 5 page objects (if there are 5 present in the target site).\n```\nGET /wiki/api/v2/pages?limit=5\n```\n\nIf there are additional pages available, the `Link` header will look like:\n```\n</wiki/api/v2/pages?limit=5&cursor=<cursor token>>; rel=\"next\"\n```\nThe URL within the `Link` header will allow you to access the next 5 pages, while the `rel=\"next\"` denotes that the URL refers to the \"next\" set of pages. Relations for a single URL are separated by semicolons (;) and URLs are separated by commas (,)\nIf there are no related URLs, the `Link` header will not be present in the response and neither will the `next` property for `_links` in the response body."