--- title: "Get a list of Containers" method: POST path: "/containers/list" tags: ["containers"] --- # Get a list of Containers `POST /containers/list` This operation gets a list of Containers, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed. ## Request body - ContainerListMetadata — All api calls that return a list will have this metadata block as input - `filter` string — The filter in FIQL syntax used for the results. - `kind` string — The kind name - `sort_order` string — The sort order in which results are returned - `offset` integer — Offset from the start of the entity list - `length` integer — The number of records to retrieve relative to the offset - `sort_attribute` string — The attribute to perform sort on ## Response `200` Success - ContainerListIntentResponse — Response object for intentful operation of containers - `entities` ContainerIntentResource[] - `status` ContainerDefStatus — Container Status Definition. - `state` string — State of the container. - `message_list` MessageResource[] - `message` string, required — If state is ERROR, a message describing the error. - `reason` string, required — If state is ERROR, a machine-readable snake-cased string. - `details` object — Custom key-value details relevant to the status. - `name` string, required — Container name. - `resources` ContainerResourcesDefStatus, required — Container Resources Status Definition. - `registry_reference` DockerRegistryReference — The reference to a docker_registry - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `image_name` string, required — Image name used for container. - `volume_list` VolumeGroupDefStatus[] — Volumes associated with this container. - `state` string — The state of the volume group entity. - `message_list` MessageResource[] - `message` string, required — If state is ERROR, a message describing the error. - `reason` string, required — If state is ERROR, a machine-readable snake-cased string. - `details` object — Custom key-value details relevant to the status. - `name` string, required — Volume group name. - `resources` VolumeGroupResources, required — Volume group resources. - `flash_mode` string — Flash Mode, if enabled all volume disks of the VG will be pinned to SSD tier. - `iscsi_target_name` string — iSCSI target full name - `file_system_type` string — File system to be used for volume - `size_bytes` integer — The total size of the Volume Group in bytes - `sharing_status` string — Whether the volume group can be shared across multiple iSCSI initiators. - `attachment_list` AttachmentReference[] — VMs attached to volume group. - … - `disk_list` VolumeDiskResource[] — Volume group disk specification. - … - `size_mib` integer — The total size of the Volume Group in mib - `iscsi_target_prefix` string — iSCSI target prefix-name. - `description` string — Volume group description. - `container_state` string — Current state of the Container. - `runtime_name` string — Name of container given by runtime. - `container_options` ContainerOptionsStatus — Container options in use by the container - `network_port_bindings` unknown - `volume_mount_map` unknown - `container_runtime` string — Name of container runtime. - `container_additional_options` string — Additional options to be used for container. - `num_cpu_shares` integer — Number of cpu shares. - `environments` unknown - `command` string — Command to be executed for the container. - `restart_policy` string — Container restart policy. - `memory_mib` integer — Memory in MiBs. - `subnet_reference_list` SubnetReference[] — Networks associated with this container. - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `volume_reference_list` VolumeGroupReference[] — Referenced Volumes associated with this container. - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `spec` Container — Container Entity Definition. - `name` string — Container name. - `resources` ContainerResources, required — Container Resources Definition. - `container_state` string — Desired state of the container. - `container_options` ContainerOptions — Container options required to run the container. - `network_port_bindings` unknown - `volume_mount_map` unknown - `container_runtime` string — Name of container runtime. - `container_additional_options` string — Additional options to be used for container. - `num_cpu_shares` integer — Number of cpu shares. - `environments` unknown - `command` string — Command to be executed in the container. - `restart_policy` string — Container restart policy. - `memory_mib` integer — Memory in MiBs. - `registry_reference` DockerRegistryReference — The reference to a docker_registry - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `subnet_reference_list` SubnetReference[] — Networks associated with this container. - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `volume_reference_list` VolumeGroupReference[] — Referenced volumes associated with this container. - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `image_name` string, required — Image name to be used for container. - `volume_list` VolumeGroup[] — Volumes associated with this container. - `name` string, required — Volume group name. - `resources` VolumeGroupResources, required — Volume group resources. - `flash_mode` string — Flash Mode, if enabled all volume disks of the VG will be pinned to SSD tier. - `iscsi_target_name` string — iSCSI target full name - `file_system_type` string — File system to be used for volume - `size_bytes` integer — The total size of the Volume Group in bytes - `sharing_status` string — Whether the volume group can be shared across multiple iSCSI initiators. - `attachment_list` AttachmentReference[] — VMs attached to volume group. - … - `disk_list` VolumeDiskResource[] — Volume group disk specification. - … - `size_mib` integer — The total size of the Volume Group in mib - `iscsi_target_prefix` string — iSCSI target prefix-name. - `description` string — Volume group description. - `api_version` string - `metadata` ContainerMetadata, required — The container kind metadata - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when container was last updated - `kind` string, required — The kind name - `uuid` string, UUID — container uuid - `spec_version` integer — Version number of the latest spec. - `creation_time` string, date-time — UTC date and time in RFC-3339 format when container was created - `spec_hash` string — Hash of the spec. This will be returned from server. - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema. - `owner_reference` UserReference — The reference to a user - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `categories` object — Categories for the container - `name` string — container name - `api_version` string, required - `metadata` ContainerListMetadataOutput, required — All api calls that return a list will have this metadata block - `filter` string — The filter used for the results - `kind` string — The kind name - `sort_order` string — The sort order in which results are returned - `offset` integer — Offset from the start of the entity list - `total_matches` integer — Total matches found - `length` integer — The number of records retrieved relative to the offset - `sort_attribute` string — The attribute to perform sort on ## Other responses - `default` — Internal Error --- [API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)