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 Containers 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: - description: The Containers API allows you to query container data for your organization. See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for more information. name: Containers paths: /api/v2/container_images: get: description: Get all Container Images for your organization. operationId: ListContainerImages parameters: - description: Comma-separated list of tags to filter Container Images by. example: short_image:redis,status:running in: query name: filter[tags] required: false schema: type: string - description: Comma-separated list of tags to group Container Images by. example: registry,image_tags in: query name: group_by required: false schema: type: string - description: Attribute to sort Container Images by. example: container_count in: query name: sort required: false schema: type: string - description: Maximum number of results returned. in: query name: page[size] required: false schema: default: 1000 format: int32 maximum: 10000 minimum: 1 type: integer example: 42 - description: 'String to query the next page of results. This key is provided with each valid response from the API in `meta.pagination.next_cursor`.' in: query name: page[cursor] required: false schema: type: string example: example_value responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContainerImagesResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Get All Container Images tags: - Containers x-menu-order: 1 x-pagination: cursorParam: page[cursor] cursorPath: meta.pagination.next_cursor limitParam: page[size] resultsPath: data x-permission: operator: OPEN permissions: [] x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/containers: get: description: Get all containers for your organization. operationId: ListContainers parameters: - description: Comma-separated list of tags to filter containers by. example: env:prod,short_image:cassandra in: query name: filter[tags] required: false schema: type: string - description: Comma-separated list of tags to group containers by. example: datacenter,cluster in: query name: group_by required: false schema: type: string - description: Attribute to sort containers by. example: started_at in: query name: sort required: false schema: type: string - description: Maximum number of results returned. in: query name: page[size] required: false schema: default: 1000 format: int32 maximum: 10000 minimum: 1 type: integer example: 42 - description: 'String to query the next page of results. This key is provided with each valid response from the API in `meta.pagination.next_cursor`.' in: query name: page[cursor] required: false schema: type: string example: example_value responses: '200': content: application/json: schema: $ref: '#/components/schemas/ContainersResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Authentication Error '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] summary: Datadog Get All Containers tags: - Containers x-menu-order: 1 x-pagination: cursorParam: page[cursor] cursorPath: meta.pagination.next_cursor limitParam: page[size] resultsPath: data x-permission: operator: OPEN permissions: [] 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: - Containers 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: ContainerImageItem: description: Possible Container Image models. oneOf: - $ref: '#/components/schemas/ContainerImage' - $ref: '#/components/schemas/ContainerImageGroup' ContainerImageFlavor: description: Container Image breakdown by supported platform. properties: built_at: description: Time the platform-specific Container Image was built. type: string example: example_value os_architecture: description: Operating System architecture supported by the Container Image. type: string example: example_value os_name: description: Operating System name supported by the Container Image. type: string example: Example Monitor os_version: description: Operating System version supported by the Container Image. type: string example: example_value size: description: Size of the platform-specific Container Image. format: int64 type: integer example: 42 type: object ContainerImageMeta: description: Response metadata object. properties: pagination: $ref: '#/components/schemas/ContainerImageMetaPage' type: object ContainerGroupRelationships: description: Relationships to containers inside a container group. properties: containers: $ref: '#/components/schemas/ContainerGroupRelationshipsLink' 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 ContainerMetaPageType: default: cursor_limit description: Type of Container pagination. enum: - cursor_limit example: cursor_limit type: string x-enum-varnames: - CURSOR_LIMIT ContainerImageGroupImagesRelationshipsLink: description: Relationships to Container Images inside a Container Image Group. properties: data: $ref: '#/components/schemas/ContainerImageGroupRelationshipsData' links: $ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks' type: object ContainerImageGroupAttributes: description: Attributes for a Container Image Group. properties: count: description: Number of Container Images in the group. format: int64 type: integer example: 42 name: description: Name of the Container Image group. type: string example: Example Monitor tags: description: Tags from the group name parsed in key/value format. type: object type: object ContainerImageMetaPage: description: Paging attributes. properties: cursor: description: The cursor used to get the current results, if any. type: string example: example_value limit: description: Number of results returned format: int32 maximum: 10000 minimum: 0 type: integer example: 42 next_cursor: description: The cursor used to get the next results, if any. type: string example: example_value prev_cursor: description: The cursor used to get the previous results, if any. nullable: true type: string example: example_value total: description: Total number of records that match the query. format: int64 type: integer example: 42 type: $ref: '#/components/schemas/ContainerImageMetaPageType' type: object ContainersResponse: description: List of containers. properties: data: description: Array of Container objects. items: $ref: '#/components/schemas/ContainerItem' type: array links: $ref: '#/components/schemas/ContainersResponseLinks' meta: $ref: '#/components/schemas/ContainerMeta' type: object ContainerImageGroupRelationshipsLinks: description: Links attributes. properties: related: description: Link to related Container Images. type: string example: example_value 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 ContainerImageGroup: description: Container Image Group object. properties: attributes: $ref: '#/components/schemas/ContainerImageGroupAttributes' id: description: Container Image Group ID. type: string example: abc-123-def relationships: $ref: '#/components/schemas/ContainerImageGroupRelationships' type: $ref: '#/components/schemas/ContainerImageGroupType' type: object ContainerMeta: description: Response metadata object. properties: pagination: $ref: '#/components/schemas/ContainerMetaPage' type: object ContainerImagesResponseLinks: description: Pagination links. properties: first: description: Link to the first page. type: string example: example_value last: description: Link to the last page. nullable: true type: string example: example_value next: description: Link to the next page. nullable: true type: string example: example_value prev: description: Link to previous page. nullable: true type: string example: example_value self: description: Link to current page. type: string example: example_value type: object ContainerImageType: default: container_image description: Type of Container Image. enum: - container_image example: container_image type: string x-enum-varnames: - CONTAINER_IMAGE ContainerItem: description: Possible Container models. oneOf: - $ref: '#/components/schemas/Container' - $ref: '#/components/schemas/ContainerGroup' ContainerImage: description: Container Image object. properties: attributes: $ref: '#/components/schemas/ContainerImageAttributes' id: description: Container Image ID. type: string example: abc-123-def type: $ref: '#/components/schemas/ContainerImageType' type: object CsmHostsAndContainersCoverageAnalysisResponse: description: CSM Hosts and Containers Coverage Analysis response. properties: data: $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisData' type: object ContainerGroupRelationshipsLinks: description: Links attributes. properties: related: description: Link to related containers. type: string example: example_value type: object ContainerGroupAttributes: description: Attributes for a container group. properties: count: description: Number of containers in the group. format: int64 type: integer example: 42 tags: description: Tags from the group name parsed in key/value format. type: object type: object ContainerMetaPage: description: Paging attributes. properties: cursor: description: The cursor used to get the current results, if any. type: string example: example_value limit: description: Number of results returned format: int32 maximum: 10000 minimum: 0 type: integer example: 42 next_cursor: description: The cursor used to get the next results, if any. type: string example: example_value prev_cursor: description: The cursor used to get the previous results, if any. nullable: true type: string example: example_value total: description: Total number of records that match the query. format: int64 type: integer example: 42 type: $ref: '#/components/schemas/ContainerMetaPageType' type: object ContainerImageGroupType: default: container_image_group description: Type of Container Image Group. enum: - container_image_group example: container_image_group type: string x-enum-varnames: - CONTAINER_IMAGE_GROUP ContainerGroupRelationshipsData: description: Links data. items: description: A link data. type: string type: array 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 ContainerGroup: description: Container group object. properties: attributes: $ref: '#/components/schemas/ContainerGroupAttributes' id: description: Container Group ID. type: string example: abc-123-def relationships: $ref: '#/components/schemas/ContainerGroupRelationships' type: $ref: '#/components/schemas/ContainerGroupType' type: object ContainerType: default: container description: Type of container. enum: - container example: container type: string x-enum-varnames: - CONTAINER ContainerImageVulnerabilities: description: Vulnerability counts associated with the Container Image. properties: asset_id: description: ID of the Container Image. type: string example: abc-123-def critical: description: Number of vulnerabilities with CVSS Critical severity. format: int64 type: integer example: 42 high: description: Number of vulnerabilities with CVSS High severity. format: int64 type: integer example: 42 low: description: Number of vulnerabilities with CVSS Low severity. format: int64 type: integer example: 42 medium: description: Number of vulnerabilities with CVSS Medium severity. format: int64 type: integer example: 42 none: description: Number of vulnerabilities with CVSS None severity. format: int64 type: integer example: 42 unknown: description: Number of vulnerabilities with an unknown CVSS severity. format: int64 type: integer example: 42 type: object ContainerImageGroupRelationshipsData: description: Links data. items: description: A link data. type: string type: array ContainersResponseLinks: description: Pagination links. properties: first: description: Link to the first page. type: string example: example_value last: description: Link to the last page. nullable: true type: string example: example_value next: description: Link to the next page. nullable: true type: string example: example_value prev: description: Link to previous page. nullable: true type: string example: example_value self: description: Link to current page. type: string example: example_value type: object ContainerImageMetaPageType: default: cursor_limit description: Type of Container Image pagination. enum: - cursor_limit example: cursor_limit type: string x-enum-varnames: - CURSOR_LIMIT ContainerAttributes: description: Attributes for a container. properties: container_id: description: The ID of the container. type: string example: abc-123-def created_at: description: Time the container was created. type: string example: example_value host: description: Hostname of the host running the container. type: string example: example_value image_digest: description: Digest of the compressed image manifest. nullable: true type: string example: example_value image_name: description: Name of the associated container image. type: string example: Example Monitor image_tags: description: List of image tags associated with the container image. items: type: string nullable: true type: array name: description: Name of the container. type: string example: Example Monitor started_at: description: Time the container was started. type: string example: example_value state: description: State of the container. This depends on the container runtime. type: string example: example_value tags: description: List of tags associated with the container. items: type: string type: array 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 ContainerImagesResponse: description: List of Container Images. properties: data: description: Array of Container Image objects. items: $ref: '#/components/schemas/ContainerImageItem' type: array links: $ref: '#/components/schemas/ContainerImagesResponseLinks' meta: $ref: '#/components/schemas/ContainerImageMeta' type: object ContainerImageGroupRelationships: description: Relationships inside a Container Image Group. properties: container_images: $ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink' type: object ContainerGroupType: default: container_group description: Type of container group. enum: - container_group example: container_group type: string x-enum-varnames: - CONTAINER_GROUP Container: description: Container object. properties: attributes: $ref: '#/components/schemas/ContainerAttributes' id: description: Container ID. type: string example: abc-123-def type: $ref: '#/components/schemas/ContainerType' type: object ContainerImageAttributes: description: Attributes for a Container Image. properties: container_count: description: Number of containers running the image. format: int64 type: integer example: 42 image_flavors: description: 'List of platform-specific images associated with the image record. The list contains more than 1 entry for multi-architecture images.' items: $ref: '#/components/schemas/ContainerImageFlavor' type: array image_tags: description: List of image tags associated with the Container Image. items: description: An image tag associated with the Container Image. type: string type: array images_built_at: description: 'List of build times associated with the Container Image. The list contains more than 1 entry for multi-architecture images.' items: description: Time the platform-specific Container Image was built. type: string type: array name: description: Name of the Container Image. type: string example: Example Monitor os_architectures: description: List of Operating System architectures supported by the Container Image. items: description: Operating System architecture supported by the Container Image. example: amd64 type: string type: array os_names: description: List of Operating System names supported by the Container Image. items: description: Operating System supported by the Container Image. example: linux type: string type: array os_versions: description: List of Operating System versions supported by the Container Image. items: description: Operating System version supported by the Container Image. type: string type: array published_at: description: Time the image was pushed to the container registry. type: string example: example_value registry: description: Registry the Container Image was pushed to. type: string example: example_value repo_digest: description: Digest of the compressed image manifest. type: string example: example_value repository: description: Repository where the Container Image is stored in. type: string example: example_value short_image: description: Short version of the Container Image name. type: string example: example_value sizes: description: 'List of size for each platform-specific image associated with the image record. The list contains more than 1 entry for multi-architecture images.' items: description: Size of the platform-specific Container Image. format: int64 type: integer type: array sources: description: List of sources where the Container Image was collected from. items: description: Source where the Container Image was collected from. type: string type: array tags: description: List of tags associated with the Container Image. items: description: A tag associated with the Container Image. type: string type: array vulnerability_count: $ref: '#/components/schemas/ContainerImageVulnerabilities' type: object ContainerGroupRelationshipsLink: description: Relationships to Containers inside a Container Group. properties: data: $ref: '#/components/schemas/ContainerGroupRelationshipsData' links: $ref: '#/components/schemas/ContainerGroupRelationshipsLinks' 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