> ## Documentation Index
> Fetch the complete documentation index at: https://kosli-reference-docs-v2-30-1.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Environment coverage for a control

> **Beta** — the Controls feature is in beta. Requests from organizations without it enabled receive `403 Forbidden`.



## OpenAPI

````yaml https://app.kosli.com/api/v2/openapi.json get /controls/{org}/{identifier}/coverage
openapi: 3.1.0
info:
  title: Kosli API
  summary: The API for communicating with Kosli
  description: >

    # Authentication 


    When making requests against Kosli API, you can authenticate your requests
    using a bearer token. 

    Set the bearer token in the request Authorization header to a valid API
    key. 

    API Keys can be personal or for service accounts. Check the [service
    accounts
    documentation](https://docs.kosli.com/getting_started/service-accounts/) for
    details. 


    ## Curl example


    ```shell

    curl -H "Authorization: Bearer <<your-api-key>>"
    https://app.kosli.com/api/v2/environments/<<your-org-name>>

    ```
  version: '2.0'
servers:
  - url: https://app.kosli.com/api/v2
    description: EU
  - url: https://app.us.kosli.com/api/v2
    description: US
security:
  - HTTPBearer: []
paths:
  /controls/{org}/{identifier}/coverage:
    get:
      tags:
        - Controls
      summary: Environment coverage for a control
      description: >-
        **Beta** — the Controls feature is in beta. Requests from organizations
        without it enabled receive `403 Forbidden`.
      operationId: get_control_coverage
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
            title: Identifier
        - name: org
          in: path
          required: true
          schema:
            type: string
            title: Org
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of environments per page
            default: 15
            title: Per Page
          description: Number of environments per page
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter environments by name (case-insensitive substring)
            title: Search
          description: Filter environments by name (case-insensitive substring)
        - name: covered
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: 'Filter by coverage state: true (covered) or false (not covered)'
            title: Covered
          description: 'Filter by coverage state: true (covered) or false (not covered)'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlCoverageResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/fastapi_app__errors__ForbiddenResponse___locals___ForbiddenResponseModel__11
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/fastapi_app__errors__NotFoundResponse___locals___NotFoundResponseModel__44
          description: Not Found
      security:
        - HTTPBearer: []
        - HTTPBasic: []
components:
  schemas:
    ControlCoverageResponse:
      properties:
        _links:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Links
        page:
          type: integer
          title: Page
        per_page:
          type: integer
          title: Per Page
        total_pages:
          type: integer
          title: Total Pages
        total_count:
          type: integer
          title: Total Count
        summary:
          $ref: '#/components/schemas/ControlCoverageSummary'
        environments:
          items:
            $ref: '#/components/schemas/ControlCoverageEnvironmentItem'
          type: array
          title: Environments
      additionalProperties: false
      type: object
      required:
        - page
        - per_page
        - total_pages
        - total_count
        - summary
        - environments
      title: ControlCoverageResponse
    fastapi_app__errors__ForbiddenResponse___locals___ForbiddenResponseModel__11:
      properties:
        message:
          type: string
          title: Message
          description: Error message
        errors:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Errors
          description: Validation errors by field
      type: object
      required:
        - message
      title: ForbiddenResponseModel
      examples:
        - message: You don't have permission to access this resource
    fastapi_app__errors__NotFoundResponse___locals___NotFoundResponseModel__44:
      properties:
        message:
          type: string
          title: Message
          description: Error message
        errors:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Errors
          description: Validation errors by field
      type: object
      required:
        - message
      title: NotFoundResponseModel
      description: Control not found
      examples:
        - message: Control not found
    ControlCoverageSummary:
      properties:
        environments:
          type: integer
          title: Environments
        covered:
          type: integer
          title: Covered
        coverage_percent:
          type: integer
          title: Coverage Percent
      type: object
      required:
        - environments
        - covered
        - coverage_percent
      title: ControlCoverageSummary
    ControlCoverageEnvironmentItem:
      properties:
        name:
          type: string
          title: Name
        covered:
          type: boolean
          title: Covered
        policy:
          anyOf:
            - type: string
            - type: 'null'
          title: Policy
      type: object
      required:
        - name
        - covered
      title: ControlCoverageEnvironmentItem
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````