openapi: 3.0.0
info:
  contact:
    email: support@datadoghq.com
    name: Datadog Support
    url: https://www.datadoghq.com/support/
  description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
  title: Datadog Account Coverage API
  version: '1.0'
servers:
- url: https://{subdomain}.{site}
  variables:
    site:
      default: datadoghq.com
      description: The regional site for Datadog customers.
      enum:
      - datadoghq.com
      - us3.datadoghq.com
      - us5.datadoghq.com
      - ap1.datadoghq.com
      - datadoghq.eu
      - ddog-gov.com
    subdomain:
      default: api
      description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
  variables:
    name:
      default: api.datadoghq.com
      description: Full site DNS name.
    protocol:
      default: https
      description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
  variables:
    site:
      default: datadoghq.com
      description: Any Datadog deployment.
    subdomain:
      default: api
      description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
  appKeyAuth: []
tags:
- name: Coverage
paths:
  /api/v2/csm/onboarding/coverage_analysis/cloud_accounts:
    get:
      description: 'Get the CSM Coverage Analysis of your Cloud Accounts.

        This is calculated based on the number of your Cloud Accounts that are

        scanned for security issues.'
      operationId: GetCSMCloudAccountsCoverageAnalysis
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse'
          description: OK
        '403':
          $ref: '#/components/responses/NotAuthorizedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Get the Csm Cloud Accounts Coverage Analysis
      tags:
      - Coverage
      x-menu-order: 1
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/csm/onboarding/coverage_analysis/hosts_and_containers:
    get:
      description: 'Get the CSM Coverage Analysis of your Hosts and Containers.

        This is calculated based on the number of agents running on your Hosts

        and Containers with CSM feature(s) enabled.'
      operationId: GetCSMHostsAndContainersCoverageAnalysis
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse'
          description: OK
        '403':
          $ref: '#/components/responses/NotAuthorizedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Get the Csm Hosts and Containers Coverage Analysis
      tags:
      - Coverage
      x-menu-order: 1
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/csm/onboarding/coverage_analysis/serverless:
    get:
      description: 'Get the CSM Coverage Analysis of your Serverless Resources.

        This is calculated based on the number of agents running on your Serverless

        Resources with CSM feature(s) enabled.'
      operationId: GetCSMServerlessCoverageAnalysis
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CsmServerlessCoverageAnalysisResponse'
          description: OK
        '403':
          $ref: '#/components/responses/NotAuthorizedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Get the Csm Serverless Coverage Analysis
      tags:
      - Coverage
      x-menu-order: 1
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    APIErrorResponse:
      description: API error response.
      properties:
        errors:
          description: A list of errors.
          example:
          - Bad Request
          items:
            description: A list of items.
            example: Bad Request
            type: string
          type: array
      required:
      - errors
      type: object
    CsmServerlessCoverageAnalysisResponse:
      description: CSM Serverless Resources Coverage Analysis response.
      properties:
        data:
          $ref: '#/components/schemas/CsmServerlessCoverageAnalysisData'
      type: object
    CsmServerlessCoverageAnalysisData:
      description: CSM Serverless Resources Coverage Analysis data.
      properties:
        attributes:
          $ref: '#/components/schemas/CsmServerlessCoverageAnalysisAttributes'
        id:
          description: The ID of your organization.
          example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
          type: string
        type:
          default: get_serverless_coverage_analysis_response_public_v0
          description: The type of the resource. The value should always be `get_serverless_coverage_analysis_response_public_v0`.
          example: get_serverless_coverage_analysis_response_public_v0
          type: string
      type: object
    CsmServerlessCoverageAnalysisAttributes:
      description: CSM Serverless Resources Coverage Analysis attributes.
      properties:
        cws_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        org_id:
          description: The ID of your organization.
          example: 123456
          format: int64
          type: integer
        total_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
      type: object
    CsmHostsAndContainersCoverageAnalysisData:
      description: CSM Hosts and Containers Coverage Analysis data.
      properties:
        attributes:
          $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes'
        id:
          description: The ID of your organization.
          example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
          type: string
        type:
          default: get_hosts_and_containers_coverage_analysis_response_public_v0
          description: The type of the resource. The value should always be `get_hosts_and_containers_coverage_analysis_response_public_v0`.
          example: get_hosts_and_containers_coverage_analysis_response_public_v0
          type: string
      type: object
    CsmCloudAccountsCoverageAnalysisResponse:
      description: CSM Cloud Accounts Coverage Analysis response.
      properties:
        data:
          $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisData'
      type: object
    CsmHostsAndContainersCoverageAnalysisAttributes:
      description: CSM Hosts and Containers Coverage Analysis attributes.
      properties:
        cspm_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        cws_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        org_id:
          description: The ID of your organization.
          example: 123456
          format: int64
          type: integer
        total_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        vm_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
      type: object
    CsmCoverageAnalysis:
      description: CSM Coverage Analysis.
      properties:
        configured_resources_count:
          description: The number of fully configured resources.
          example: 8
          format: int64
          type: integer
        coverage:
          description: The coverage percentage.
          example: 0.8
          format: double
          type: number
        partially_configured_resources_count:
          description: The number of partially configured resources.
          example: 0
          format: int64
          type: integer
        total_resources_count:
          description: The total number of resources.
          example: 10
          format: int64
          type: integer
      type: object
    CsmHostsAndContainersCoverageAnalysisResponse:
      description: CSM Hosts and Containers Coverage Analysis response.
      properties:
        data:
          $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisData'
      type: object
    CsmCloudAccountsCoverageAnalysisAttributes:
      description: CSM Cloud Accounts Coverage Analysis attributes.
      properties:
        aws_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        azure_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        gcp_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
        org_id:
          description: The ID of your organization.
          example: 123456
          format: int64
          type: integer
        total_coverage:
          $ref: '#/components/schemas/CsmCoverageAnalysis'
      type: object
    CsmCloudAccountsCoverageAnalysisData:
      description: CSM Cloud Accounts Coverage Analysis data.
      properties:
        attributes:
          $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes'
        id:
          description: The ID of your organization.
          example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
          type: string
        type:
          default: get_cloud_accounts_coverage_analysis_response_public_v0
          description: The type of the resource. The value should always be `get_cloud_accounts_coverage_analysis_response_public_v0`.
          example: get_cloud_accounts_coverage_analysis_response_public_v0
          type: string
      type: object
  responses:
    TooManyRequestsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Too many requests
    NotAuthorizedResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Not Authorized
  securitySchemes:
    AuthZ:
      description: This API uses OAuth 2 with the implicit grant flow.
      flows:
        authorizationCode:
          authorizationUrl: /oauth2/v1/authorize
          scopes:
            apm_api_catalog_read: View API catalog and API definitions.
            apm_api_catalog_write: Add, modify, and delete API catalog definitions.
            apm_read: Read and query APM and Trace Analytics.
            apm_service_catalog_read: View service catalog and service definitions.
            apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
            appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
            cases_read: View Cases.
            cases_write: Create and update cases.
            ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
            ci_visibility_read: View CI Visibility.
            cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
            cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
            code_analysis_read: View Code Analysis.
            continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
            create_webhooks: Create webhooks integrations.
            dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
            dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
            dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
            dashboards_read: View dashboards.
            dashboards_write: Create and change dashboards.
            data_scanner_read: View Data Scanner configurations.
            data_scanner_write: Edit Data Scanner configurations.
            embeddable_graphs_share: Generate public links to share embeddable graphs externally.
            events_read: Read Events data.
            hosts_read: List hosts and their attributes.
            incident_notification_settings_write: Configure Incidents Notification settings.
            incident_read: View incidents in Datadog.
            incident_settings_write: Configure Incident Settings.
            incident_write: Create, view, and manage incidents in Datadog.
            metrics_read: View custom metrics.
            monitor_config_policy_write: Edit and delete monitor configuration.
            monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
            monitors_read: View monitors.
            monitors_write: Edit, delete, and resolve individual monitors.
            org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
            security_comments_read: Read comments of vulnerabilities.
            security_monitoring_filters_read: Read Security Filters.
            security_monitoring_filters_write: Create, edit, and delete Security Filters.
            security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
            security_monitoring_notification_profiles_read: View Rule Security Notification rules.
            security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
            security_monitoring_rules_read: Read Detection Rules.
            security_monitoring_rules_write: Create and edit Detection Rules.
            security_monitoring_signals_read: View Security Signals.
            security_monitoring_suppressions_read: Read Rule Suppressions.
            security_monitoring_suppressions_write: Write Rule Suppressions.
            security_pipelines_read: View Security Pipelines.
            security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
            slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
            slos_read: View SLOs and status corrections.
            slos_write: Create, edit, and delete SLOs.
            synthetics_global_variable_read: View, search, and use Synthetics global variables.
            synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
            synthetics_private_location_read: View, search, and use Synthetics private locations.
            synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
            synthetics_read: List and view configured Synthetic tests and test results.
            synthetics_write: Create, edit, and delete Synthetic tests.
            teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
            teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
            test_optimization_read: View Test Optimization.
            timeseries_query: Query Timeseries data.
            usage_read: View your organization's usage and usage attribution.
            user_access_invite: Invite other users to your organization.
            user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
            user_access_read: View users and their roles and settings.
            workflows_read: View workflows.
            workflows_run: Run workflows.
            workflows_write: Create, edit, and delete workflows.
          tokenUrl: /oauth2/v1/token
      type: oauth2
    apiKeyAuth:
      description: Your Datadog API Key.
      in: header
      name: DD-API-KEY
      type: apiKey
      x-env-name: DD_API_KEY
    appKeyAuth:
      description: Your Datadog APP Key.
      in: header
      name: DD-APPLICATION-KEY
      type: apiKey
      x-env-name: DD_APP_KEY
    bearerAuth:
      scheme: bearer
      type: http
      x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
  paths: false