Skip to main content

container_images

Creates, updates, deletes, gets or lists a container_images resource.

Overview

Namecontainer_images
TypeResource
Iddatadog.infrastructure.container_images

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringContainer Image ID.
attributesobjectAttributes for a Container Image.
relationshipsobjectRelationships inside a Container Image Group.
typestringType of Container Image. (container_image) (default: container_image, example: container_image)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_container_imagesselectfilter[tags], group_by, sort, page[size], page[cursor]Get all Container Images for your organization.<br />Note: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https:​//docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
sitestringThe Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[tags]stringComma-separated list of tags to filter Container Images by. (example: short_image:redis,status:running)
group_bystringComma-separated list of tags to group Container Images by. (example: registry,image_tags)
page[cursor]stringString to query the next page of results. This key is provided with each valid response from the API in meta.pagination.next_cursor.
page[size]integer (int32)Maximum number of results returned.
sortstringAttribute to sort Container Images by. (example: container_count)

SELECT examples

Get all Container Images for your organization.<br />Note: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https:​//docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint.

SELECT
id,
attributes,
relationships,
type
FROM datadog.infrastructure.container_images
WHERE filter[tags] = '{{ filter[tags] }}'
AND group_by = '{{ group_by }}'
AND sort = '{{ sort }}'
AND page[size] = '{{ page[size] }}'
AND page[cursor] = '{{ page[cursor] }}'
;