MongoDB Atlas Administration API — Online Archive

naftiko: 1.0.0-alpha2
info:
  label: MongoDB Atlas Administration API — Online Archive
  description: 'MongoDB Atlas Administration API — Online Archive. 6 operations. Lead operation: Return All Online Archives
    for One Cluster. Self-contained Naftiko capability covering one Mongodb business surface.'
  tags:
  - Mongodb
  - Online Archive
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MONGODB_API_KEY: MONGODB_API_KEY
capability:
  consumes:
  - type: http
    namespace: atlas-online-archive
    baseUri: https://cloud.mongodb.com
    description: MongoDB Atlas Administration API — Online Archive business capability. Self-contained, no shared references.
    resources:
    - name: api-atlas-v2-groups-groupId-clusters-clusterName-onlineArchives
      path: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives
      operations:
      - name: listgroupclusteronlinearchives
        method: GET
        description: Return All Online Archives for One Cluster
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clusterName
          in: path
          type: string
          description: Human-readable label that identifies the cluster that contains the collection for which you want to
            return the online archives.
          required: true
      - name: creategroupclusteronlinearchive
        method: POST
        description: Create One Online Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clusterName
          in: path
          type: string
          description: Human-readable label that identifies the cluster that contains the collection for which you want to
            create one online archive.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-atlas-v2-groups-groupId-clusters-clusterName-onlineArchives-queryLogs.gz
      path: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz
      operations:
      - name: downloadgroupclusteronlinearchivequerylogs
        method: GET
        description: Download Online Archive Query Logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: integer
          description: Date and time that specifies the starting point for the range of log messages to return. This resource
            expresses this value in the number of seconds that have e
        - name: endDate
          in: query
          type: integer
          description: Date and time that specifies the end point for the range of log messages to return. This resource expresses
            this value in the number of seconds that have elapse
        - name: clusterName
          in: path
          type: string
          description: Human-readable label that identifies the cluster that contains the collection for which you want to
            return the query logs from one online archive.
          required: true
        - name: archiveOnly
          in: query
          type: boolean
          description: Flag that indicates whether to download logs for queries against your online archive only or both your
            online archive and cluster.
    - name: api-atlas-v2-groups-groupId-clusters-clusterName-onlineArchives-archiveId
      path: /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}
      operations:
      - name: deletegroupclusteronlinearchive
        method: DELETE
        description: Remove One Online Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: archiveId
          in: path
          type: string
          description: Unique 24-hexadecimal digit string that identifies the online archive to delete.
          required: true
        - name: clusterName
          in: path
          type: string
          description: Human-readable label that identifies the cluster that contains the collection from which you want to
            remove an online archive.
          required: true
      - name: getgroupclusteronlinearchive
        method: GET
        description: Return One Online Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: archiveId
          in: path
          type: string
          description: Unique 24-hexadecimal digit string that identifies the online archive to return.
          required: true
        - name: clusterName
          in: path
          type: string
          description: Human-readable label that identifies the cluster that contains the specified collection from which
            Application created the online archive.
          required: true
      - name: updategroupclusteronlinearchive
        method: PATCH
        description: Update One Online Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: archiveId
          in: path
          type: string
          description: Unique 24-hexadecimal digit string that identifies the online archive to update.
          required: true
        - name: clusterName
          in: path
          type: string
          description: Human-readable label that identifies the cluster that contains the specified collection from which
            Application created the online archive.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.MONGODB_API_KEY}}'
  exposes:
  - type: rest
    namespace: atlas-online-archive-rest
    port: 8080
    description: REST adapter for MongoDB Atlas Administration API — Online Archive. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/atlas/v2/groups/{groupid}/clusters/{clustername}/onlinearchives
      name: api-atlas-v2-groups-groupid-clusters-clustername-onlinearchives
      description: REST surface for api-atlas-v2-groups-groupId-clusters-clusterName-onlineArchives.
      operations:
      - method: GET
        name: listgroupclusteronlinearchives
        description: Return All Online Archives for One Cluster
        call: atlas-online-archive.listgroupclusteronlinearchives
        with:
          clusterName: rest.clusterName
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroupclusteronlinearchive
        description: Create One Online Archive
        call: atlas-online-archive.creategroupclusteronlinearchive
        with:
          clusterName: rest.clusterName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/groups/{groupid}/clusters/{clustername}/onlinearchives/querylogs-gz
      name: api-atlas-v2-groups-groupid-clusters-clustername-onlinearchives-querylogs-gz
      description: REST surface for api-atlas-v2-groups-groupId-clusters-clusterName-onlineArchives-queryLogs.gz.
      operations:
      - method: GET
        name: downloadgroupclusteronlinearchivequerylogs
        description: Download Online Archive Query Logs
        call: atlas-online-archive.downloadgroupclusteronlinearchivequerylogs
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          clusterName: rest.clusterName
          archiveOnly: rest.archiveOnly
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/groups/{groupid}/clusters/{clustername}/onlinearchives/{archiveid}
      name: api-atlas-v2-groups-groupid-clusters-clustername-onlinearchives-archiveid
      description: REST surface for api-atlas-v2-groups-groupId-clusters-clusterName-onlineArchives-archiveId.
      operations:
      - method: DELETE
        name: deletegroupclusteronlinearchive
        description: Remove One Online Archive
        call: atlas-online-archive.deletegroupclusteronlinearchive
        with:
          archiveId: rest.archiveId
          clusterName: rest.clusterName
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getgroupclusteronlinearchive
        description: Return One Online Archive
        call: atlas-online-archive.getgroupclusteronlinearchive
        with:
          archiveId: rest.archiveId
          clusterName: rest.clusterName
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updategroupclusteronlinearchive
        description: Update One Online Archive
        call: atlas-online-archive.updategroupclusteronlinearchive
        with:
          archiveId: rest.archiveId
          clusterName: rest.clusterName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: atlas-online-archive-mcp
    port: 9090
    transport: http
    description: MCP adapter for MongoDB Atlas Administration API — Online Archive. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: return-all-online-archives-one
      description: Return All Online Archives for One Cluster
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: atlas-online-archive.listgroupclusteronlinearchives
      with:
        clusterName: tools.clusterName
      outputParameters:
      - type: object
        mapping: $.
    - name: create-one-online-archive
      description: Create One Online Archive
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: atlas-online-archive.creategroupclusteronlinearchive
      with:
        clusterName: tools.clusterName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: download-online-archive-query-logs
      description: Download Online Archive Query Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: atlas-online-archive.downloadgroupclusteronlinearchivequerylogs
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        clusterName: tools.clusterName
        archiveOnly: tools.archiveOnly
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-one-online-archive
      description: Remove One Online Archive
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: atlas-online-archive.deletegroupclusteronlinearchive
      with:
        archiveId: tools.archiveId
        clusterName: tools.clusterName
      outputParameters:
      - type: object
        mapping: $.
    - name: return-one-online-archive
      description: Return One Online Archive
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: atlas-online-archive.getgroupclusteronlinearchive
      with:
        archiveId: tools.archiveId
        clusterName: tools.clusterName
      outputParameters:
      - type: object
        mapping: $.
    - name: update-one-online-archive
      description: Update One Online Archive
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: atlas-online-archive.updategroupclusteronlinearchive
      with:
        archiveId: tools.archiveId
        clusterName: tools.clusterName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.