Atlassian The Confluence Cloud REST API — Audit

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Confluence Cloud REST API — Audit
  description: 'Atlassian The Confluence Cloud REST API — Audit. 6 operations. Lead operation: Atlassian Get Audit Records.
    Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Audit
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: confluence-audit
    baseUri: ''
    description: Atlassian The Confluence Cloud REST API — Audit business capability. Self-contained, no shared references.
    resources:
    - name: wiki-rest-api-audit
      path: /wiki/rest/api/audit
      operations:
      - name: atlassiangetauditrecords
        method: GET
        description: Atlassian Get Audit Records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Filters the results to the records on or after the `startDate`.
        - name: endDate
          in: query
          type: string
          description: Filters the results to the records on or before the `endDate`.
        - name: searchString
          in: query
          type: string
          description: Filters the results to records that have string property values
        - name: start
          in: query
          type: integer
          description: The starting index of the returned records.
        - name: limit
          in: query
          type: integer
          description: The maximum number of records to return per page.
      - name: atlassiancreateauditrecord
        method: POST
        description: Atlassian Create Audit Record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: wiki-rest-api-audit-export
      path: /wiki/rest/api/audit/export
      operations:
      - name: atlassianexportauditrecords
        method: GET
        description: Atlassian Export Audit Records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Filters the exported results to the records on or after the `startDate`.
        - name: endDate
          in: query
          type: string
          description: Filters the exported results to the records on or before the `endDate`.
        - name: searchString
          in: query
          type: string
          description: Filters the exported results to records that have string property values
        - name: format
          in: query
          type: string
          description: The format of the export file for the audit records.
    - name: wiki-rest-api-audit-retention
      path: /wiki/rest/api/audit/retention
      operations:
      - name: atlassiangetretentionperiod
        method: GET
        description: Atlassian Get Retention Period
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: atlassiansetretentionperiod
        method: PUT
        description: Atlassian Set Retention Period
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: wiki-rest-api-audit-since
      path: /wiki/rest/api/audit/since
      operations:
      - name: atlassiangetauditrecordsfortimeperiod
        method: GET
        description: Atlassian Get Audit Records For Time Period
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: number
          in: query
          type: integer
          description: The number of units for the time period.
        - name: units
          in: query
          type: string
          description: The unit of time that the time period is measured in.
        - name: searchString
          in: query
          type: string
          description: Filters the results to records that have string property values
        - name: start
          in: query
          type: integer
          description: The starting index of the returned records.
        - name: limit
          in: query
          type: integer
          description: The maximum number of records to return per page.
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-audit-rest
    port: 8080
    description: REST adapter for Atlassian The Confluence Cloud REST API — Audit. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/audit
      name: wiki-rest-api-audit
      description: REST surface for wiki-rest-api-audit.
      operations:
      - method: GET
        name: atlassiangetauditrecords
        description: Atlassian Get Audit Records
        call: confluence-audit.atlassiangetauditrecords
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          searchString: rest.searchString
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreateauditrecord
        description: Atlassian Create Audit Record
        call: confluence-audit.atlassiancreateauditrecord
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/audit/export
      name: wiki-rest-api-audit-export
      description: REST surface for wiki-rest-api-audit-export.
      operations:
      - method: GET
        name: atlassianexportauditrecords
        description: Atlassian Export Audit Records
        call: confluence-audit.atlassianexportauditrecords
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          searchString: rest.searchString
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/audit/retention
      name: wiki-rest-api-audit-retention
      description: REST surface for wiki-rest-api-audit-retention.
      operations:
      - method: GET
        name: atlassiangetretentionperiod
        description: Atlassian Get Retention Period
        call: confluence-audit.atlassiangetretentionperiod
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassiansetretentionperiod
        description: Atlassian Set Retention Period
        call: confluence-audit.atlassiansetretentionperiod
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/audit/since
      name: wiki-rest-api-audit-since
      description: REST surface for wiki-rest-api-audit-since.
      operations:
      - method: GET
        name: atlassiangetauditrecordsfortimeperiod
        description: Atlassian Get Audit Records For Time Period
        call: confluence-audit.atlassiangetauditrecordsfortimeperiod
        with:
          number: rest.number
          units: rest.units
          searchString: rest.searchString
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: confluence-audit-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Confluence Cloud REST API — Audit. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-get-audit-records
      description: Atlassian Get Audit Records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-audit.atlassiangetauditrecords
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        searchString: tools.searchString
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-audit-record
      description: Atlassian Create Audit Record
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: confluence-audit.atlassiancreateauditrecord
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-export-audit-records
      description: Atlassian Export Audit Records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-audit.atlassianexportauditrecords
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        searchString: tools.searchString
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-retention-period
      description: Atlassian Get Retention Period
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-audit.atlassiangetretentionperiod
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-set-retention-period
      description: Atlassian Set Retention Period
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: confluence-audit.atlassiansetretentionperiod
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-audit-records-time
      description: Atlassian Get Audit Records For Time Period
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-audit.atlassiangetauditrecordsfortimeperiod
      with:
        number: tools.number
        units: tools.units
        searchString: tools.searchString
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.