Coveo Platform API — Limits

naftiko: 1.0.0-alpha2
info:
  label: Coveo Platform API — Limits
  description: 'Coveo Platform API — Limits. 5 operations. Lead operation: Show Organization Limits and Their Statuses. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Platform
  - Limits
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-limits
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Platform API — Limits business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-limits
      path: /rest/organizations/{organizationId}/limits
      operations:
      - name: getorganizationlimits
        method: GET
        description: Show Organization Limits and Their Statuses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: limitType
          in: query
          type: string
          description: The type of limit you are wishing to retrieve.
    - name: rest-organizations-organizationId-limits-reset-sectionName-limitKey
      path: /rest/organizations/{organizationId}/limits/reset/{sectionName}/{limitKey}
      operations:
      - name: resetexpiredlimitstatuses
        method: POST
        description: Manually Reset Limit Statuses for a Specific Section and Limit Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sectionName
          in: path
          type: string
          description: The name of the target license section.</br>**Example:** `content`
          required: true
        - name: limitKey
          in: path
          type: string
          description: The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`
          required: true
    - name: rest-organizations-organizationId-limits-sectionName
      path: /rest/organizations/{organizationId}/limits/{sectionName}
      operations:
      - name: getsectionlimits
        method: GET
        description: List Section Limits and Their Statuses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sectionName
          in: path
          type: string
          description: The name of the target license section.</br>**Example:** `content`
          required: true
    - name: rest-organizations-organizationId-limits-sectionName-limitKey
      path: /rest/organizations/{organizationId}/limits/{sectionName}/{limitKey}
      operations:
      - name: getlimit
        method: GET
        description: Show Specific Limit Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sectionName
          in: path
          type: string
          description: The name of the target license section.</br>**Example:** `content`
          required: true
        - name: limitKey
          in: path
          type: string
          description: The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`
          required: true
    - name: rest-organizations-organizationId-limits-sectionName-limitKey-history
      path: /rest/organizations/{organizationId}/limits/{sectionName}/{limitKey}/history
      operations:
      - name: getlimithistory
        method: GET
        description: Show Limit History
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sectionName
          in: path
          type: string
          description: The name of the target license section.</br>**Example:** `content`
          required: true
        - name: limitKey
          in: path
          type: string
          description: The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`
          required: true
        - name: from
          in: query
          type: string
          description: The beginning of the date range for which to show limit history in [ISO 8601](https://www.w3.org/TR/NOTE-datetime)
            format.</br>**Example:**`2022-05-08T01:30:00.
        - name: to
          in: query
          type: string
          description: The ending of the date range for which to show limit history in [ISO 8601](https://www.w3.org/TR/NOTE-datetime)
            format.</br>**Example:**`2022-05-10T01:30:00.000
  exposes:
  - type: rest
    namespace: platform-limits-rest
    port: 8080
    description: REST adapter for Coveo Platform API — Limits. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/limits
      name: rest-organizations-organizationid-limits
      description: REST surface for rest-organizations-organizationId-limits.
      operations:
      - method: GET
        name: getorganizationlimits
        description: Show Organization Limits and Their Statuses
        call: platform-limits.getorganizationlimits
        with:
          organizationId: rest.organizationId
          limitType: rest.limitType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/limits/reset/{sectionname}/{limitkey}
      name: rest-organizations-organizationid-limits-reset-sectionname-limitkey
      description: REST surface for rest-organizations-organizationId-limits-reset-sectionName-limitKey.
      operations:
      - method: POST
        name: resetexpiredlimitstatuses
        description: Manually Reset Limit Statuses for a Specific Section and Limit Key
        call: platform-limits.resetexpiredlimitstatuses
        with:
          organizationId: rest.organizationId
          sectionName: rest.sectionName
          limitKey: rest.limitKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/limits/{sectionname}
      name: rest-organizations-organizationid-limits-sectionname
      description: REST surface for rest-organizations-organizationId-limits-sectionName.
      operations:
      - method: GET
        name: getsectionlimits
        description: List Section Limits and Their Statuses
        call: platform-limits.getsectionlimits
        with:
          organizationId: rest.organizationId
          sectionName: rest.sectionName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/limits/{sectionname}/{limitkey}
      name: rest-organizations-organizationid-limits-sectionname-limitkey
      description: REST surface for rest-organizations-organizationId-limits-sectionName-limitKey.
      operations:
      - method: GET
        name: getlimit
        description: Show Specific Limit Status
        call: platform-limits.getlimit
        with:
          organizationId: rest.organizationId
          sectionName: rest.sectionName
          limitKey: rest.limitKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/limits/{sectionname}/{limitkey}/history
      name: rest-organizations-organizationid-limits-sectionname-limitkey-history
      description: REST surface for rest-organizations-organizationId-limits-sectionName-limitKey-history.
      operations:
      - method: GET
        name: getlimithistory
        description: Show Limit History
        call: platform-limits.getlimithistory
        with:
          organizationId: rest.organizationId
          sectionName: rest.sectionName
          limitKey: rest.limitKey
          from: rest.from
          to: rest.to
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-limits-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Platform API — Limits. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: show-organization-limits-and-their
      description: Show Organization Limits and Their Statuses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-limits.getorganizationlimits
      with:
        organizationId: tools.organizationId
        limitType: tools.limitType
      outputParameters:
      - type: object
        mapping: $.
    - name: manually-reset-limit-statuses-specific
      description: Manually Reset Limit Statuses for a Specific Section and Limit Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-limits.resetexpiredlimitstatuses
      with:
        organizationId: tools.organizationId
        sectionName: tools.sectionName
        limitKey: tools.limitKey
      outputParameters:
      - type: object
        mapping: $.
    - name: list-section-limits-and-their
      description: List Section Limits and Their Statuses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-limits.getsectionlimits
      with:
        organizationId: tools.organizationId
        sectionName: tools.sectionName
      outputParameters:
      - type: object
        mapping: $.
    - name: show-specific-limit-status
      description: Show Specific Limit Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-limits.getlimit
      with:
        organizationId: tools.organizationId
        sectionName: tools.sectionName
        limitKey: tools.limitKey
      outputParameters:
      - type: object
        mapping: $.
    - name: show-limit-history
      description: Show Limit History
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-limits.getlimithistory
      with:
        organizationId: tools.organizationId
        sectionName: tools.sectionName
        limitKey: tools.limitKey
        from: tools.from
        to: tools.to
      outputParameters:
      - type: object
        mapping: $.