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 Deployments 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: Deployments
paths:
  /api/v2/dora/deployment:
    post:
      description: 'Use this API endpoint to provide data about deployments for DORA metrics.


        This is necessary for:

        - Deployment Frequency

        - Change Lead Time

        - Change Failure Rate'
      operationId: CreateDORADeployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DORADeploymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DORADeploymentResponse'
          description: OK
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DORADeploymentResponse'
          description: OK - but delayed due to incident
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Bad Request
        '403':
          $ref: '#/components/responses/NotAuthorizedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      security:
      - apiKeyAuth: []
      summary: Datadog Send a Deployment Event for Dora Metrics
      tags:
      - Deployments
      x-codegen-request-body-name: body
      x-menu-order: 1
      x-undo:
        type: idempotent
      x-unstable: '**Note**: This endpoint is in public beta.

        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/dora/deployments:
    post:
      description: Use this API endpoint to get a list of deployment events.
      operationId: ListDORADeployments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DORAListDeploymentsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DORAListResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Bad Request
        '403':
          $ref: '#/components/responses/NotAuthorizedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      security:
      - apiKeyAuth: []
        appKeyAuth: []
      summary: Datadog Get a List of Deployment Events
      tags:
      - Deployments
      x-codegen-request-body-name: body
      x-menu-order: 3
      x-permission:
        operator: OR
        permissions:
        - dora_metrics_read
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/dora/deployments/{deployment_id}:
    get:
      description: Use this API endpoint to get a deployment event.
      operationId: GetDORADeployment
      parameters:
      - description: The ID of the deployment event.
        in: path
        name: deployment_id
        required: true
        schema:
          type: string
        example: abc-123-def
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DORAFetchResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Bad Request
        '403':
          $ref: '#/components/responses/NotAuthorizedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      security:
      - apiKeyAuth: []
      - appKeyAuth: []
      summary: Datadog Get a Deployment Event
      tags:
      - Deployments
      x-codegen-request-body-name: body
      x-menu-order: 5
      x-permission:
        operator: OR
        permissions:
        - dora_metrics_read
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GitCommitSHA:
      description: Git Commit SHA.
      example: 66adc9350f2cc9b250b69abddab733dd55e1a588
      pattern: ^[a-fA-F0-9]{40,}$
      type: string
    DORADeploymentResponse:
      description: Response after receiving a DORA deployment event.
      properties:
        data:
          $ref: '#/components/schemas/DORADeploymentResponseData'
      required:
      - data
      type: object
    JSONAPIErrorItem:
      description: API error response body
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the error.
          example: Missing required attribute in body
          type: string
        meta:
          additionalProperties: {}
          description: Non-standard meta-information about the error
          type: object
        source:
          $ref: '#/components/schemas/JSONAPIErrorItemSource'
        status:
          description: Status code of the response.
          example: '400'
          type: string
        title:
          description: Short human-readable summary of the error.
          example: Bad Request
          type: string
      type: object
    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
    DORADeploymentType:
      default: dora_deployment
      description: JSON:API type for DORA deployment events.
      enum:
      - dora_deployment
      example: dora_deployment
      type: string
      x-enum-varnames:
      - DORA_DEPLOYMENT
    DORADeploymentRequestAttributes:
      description: Attributes to create a DORA deployment event.
      properties:
        env:
          description: Environment name to where the service was deployed.
          example: staging
          type: string
        finished_at:
          description: Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.
          example: 1693491984000000000
          format: int64
          type: integer
        git:
          $ref: '#/components/schemas/DORAGitInfo'
        id:
          description: Deployment ID.
          type: string
          example: abc-123-def
        service:
          description: Service name.
          example: shopist
          type: string
        started_at:
          description: Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.
          example: 1693491974000000000
          format: int64
          type: integer
        team:
          description: Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.
          example: backend
          type: string
        version:
          description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
          example: v1.12.07
          type: string
      required:
      - service
      - started_at
      - finished_at
      type: object
    DORAListDeploymentsRequest:
      description: Request to get a list of deployments.
      properties:
        data:
          $ref: '#/components/schemas/DORAListDeploymentsRequestData'
      required:
      - data
      type: object
    DORAGitInfo:
      description: Git info for DORA Metrics events.
      properties:
        commit_sha:
          $ref: '#/components/schemas/GitCommitSHA'
        repository_url:
          $ref: '#/components/schemas/GitRepositoryURL'
      required:
      - repository_url
      - commit_sha
      type: object
    DORAEvent:
      description: A DORA event.
      properties:
        attributes:
          description: The attributes of the event.
          type: object
        id:
          description: The ID of the event.
          type: string
          example: abc-123-def
        type:
          description: The type of the event.
          type: string
          example: metric alert
      type: object
    DORAListDeploymentsRequestData:
      description: The JSON:API data.
      properties:
        attributes:
          $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
        type:
          $ref: '#/components/schemas/DORAListDeploymentsRequestDataType'
      required:
      - attributes
      type: object
    JSONAPIErrorItemSource:
      description: References to the source of the error.
      properties:
        header:
          description: A string indicating the name of a single request header which caused the error.
          example: Authorization
          type: string
        parameter:
          description: A string indicating which URI query parameter caused the error.
          example: limit
          type: string
        pointer:
          description: A JSON pointer to the value in the request document that caused the error.
          example: /data/attributes/title
          type: string
      type: object
    JSONAPIErrorResponse:
      description: API error response.
      properties:
        errors:
          description: A list of errors.
          items:
            $ref: '#/components/schemas/JSONAPIErrorItem'
          type: array
      required:
      - errors
      type: object
    DORAListDeploymentsRequestAttributes:
      description: Attributes to get a list of deployments.
      properties:
        from:
          description: Minimum timestamp for requested events.
          format: date-time
          type: string
          example: example_value
        limit:
          default: 10
          description: Maximum number of events in the response.
          format: int32
          maximum: 1000
          type: integer
          example: 42
        query:
          description: Search query with event platform syntax.
          type: string
          example: avg:system.cpu.user{*}
        sort:
          description: Sort order (prefixed with `-` for descending).
          type: string
          example: example_value
        to:
          description: Maximum timestamp for requested events.
          format: date-time
          type: string
          example: example_value
      type: object
    DORADeploymentRequest:
      description: Request to create a DORA deployment event.
      properties:
        data:
          $ref: '#/components/schemas/DORADeploymentRequestData'
      required:
      - data
      type: object
    DORADeploymentRequestData:
      description: The JSON:API data.
      properties:
        attributes:
          $ref: '#/components/schemas/DORADeploymentRequestAttributes'
      required:
      - attributes
      type: object
    DORAListDeploymentsRequestDataType:
      description: The definition of `DORAListDeploymentsRequestDataType` object.
      enum:
      - dora_deployments_list_request
      type: string
      x-enum-varnames:
      - DORA_DEPLOYMENTS_LIST_REQUEST
    DORAListResponse:
      description: Response for the DORA list endpoints.
      properties:
        data:
          description: The list of DORA events.
          items:
            $ref: '#/components/schemas/DORAEvent'
          type: array
      type: object
    DORADeploymentResponseData:
      description: The JSON:API data.
      properties:
        id:
          description: The ID of the received DORA deployment event.
          example: 4242fcdd31586083
          type: string
        type:
          $ref: '#/components/schemas/DORADeploymentType'
      required:
      - id
      type: object
    GitRepositoryURL:
      description: Git Repository URL
      example: https://github.com/organization/example-repository
      type: string
    DORAFetchResponse:
      description: Response for the DORA fetch endpoints.
      properties:
        data:
          $ref: '#/components/schemas/DORAEvent'
      type: object
  responses:
    NotAuthorizedResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Not Authorized
    TooManyRequestsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Too many requests
  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