---
title: "Search Containers"
method: POST
path: "/api/v2/Entities/Containers/search"
tags: ["Entities"]
---

# Search Containers

`POST /api/v2/Entities/Containers/search`

Search for containers in your environment. Get details, such as the container name, pod name, tags, and so on, by invoking the following endpoint:  

  > `POST https://YourAccount.lacework.net/api/v2/Entities/Containers/search` 

 The results reflect containers that were active and processed by FortiCNAPP within the specified time frame. Containers that were not active and containers that have not been processed yet do not appear in the results.  

 FortiCNAPP highly recommends specifying a time range. Without a specified time range, the request uses the default time range of 24 hours prior to the current time. The maximum time range per API request is 7 days.  To use the current time as the end time, exclude the endTime field. 

 Due to the to the hourly aggregation window for container rows, any time range less than 1 hour will return no results. The specified time range will filter container rows with aggregation windows that fall in the time range. For more information, see [CONTAINER_SUMMARY_V View](https://docs.fortinet.com/document/forticnapp/latest/administration-guide/672257/container-summary-v-view). 

 You can optionally filter the returned containers by the container name, pod name, tags, and more. For more information, see [CONTAINER_SUMMARY_V View](https://docs.fortinet.com/document/forticnapp/latest/administration-guide/672257/container-summary-v-view). 

 Here are some example `body` payloads: 
 * `{ "timeFilter": { "startTime": "2021-08-28T20:30:00Z", "endTime": "2021-08-28T22:30:00Z"}}`
 * `{ "timeFilter": { "startTime": "2021-08-28T20:30:00Z", "endTime": "2021-08-28T22:30:00Z"},` 
 `"filters": [ { "field": "mid", "expression": "eq", "value": "12345" } ] }` 
 * `{ "timeFilter": { "startTime": "2021-08-28T20:30:00Z", "endTime": "2021-08-28T22:30:00Z"},`
 `"filters": [ { "field": "mid", "expression": "eq", "value": "12345" }, { "field": "propsContainer.IMAGE_TAG", "expression": "eq", "value": "v1.7.0-eksbuild.1" } ],`  
 `"returns": [ "containerName", "imageId", "podName", "propsContainer", "tags" ] }` 


 Within request bodies, nested field names that contain one or more special characters—e.g., dot ("."), colon (":"), or slash ("/")—must be enclosed in **escaped double quotes**. For example, the field name `io.codefresh.repo.name` nested under the `PROPS_LABEL` of the `propsContainer` field would be rendered as follows: 

 `"propsContainer.PROPS_LABEL.\"io.codefresh.repo.name\""` 

  In a filter, the example would appear as follows: 

 `{ "field": "propsContainer.PROPS_LABEL.\"io.codefresh.repo.name\"", "expression": "eq", "value": "modelservice" }`

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Request body

- GETDATAREQUESTBODYTIMEFILTERS
  - `timeFilter` object — The date/time range during which actions occurred.
    - `startTime` string — Returns only recorded actions that occurred after this timestamp.
    - `endTime` string — Returns only recorded actions that occurred before this timestamp. If empty or missing, the current time is used.
  - `filters` object[] — One or more condition statements you can use to refine the data returned by the request. Only records that satisfy filtering conditions are returned. If there are multiple conditions, a record must satisfy all conditions for a match.
    - `expression` 'eq' | 'ne' | 'in' | 'not_in' | 'like' | 'ilike' | 'not_like' | 'not_ilike' | 'not_rlike' | 'rlike' | 'gt' | 'ge' | 'lt' | 'le' | 'between', required — The comparison operator for the filter condition.
    - `field` string, required — The name of the data field to which the condition applies.
    - `value` string — The value that the condition checks for in the specified field. Use this attribute when specifying a single value.
    - `values` string[] — The values that the condition checks for in the specified field. Use this attribute when specifying multiple values.
  - `returns` string[] — Use this attribute to specify which top-level fields of the response schema you want to receive.

## Response `200`

No Error (List of Active Containers)

- object
  - `paging` PagingSchema — Details of the response's pagination
    - `rows` number — The number of rows displayed on each page
    - `totalRows` number — The number of rows returned from the query
    - `urls` object — Pagination-related URLs
      - `nextPage` string — The next page's URL
  - `data` EntitiesContainersResponseSchema[]
    - `startTime` string
    - `endTime` string
    - `mid` integer
    - `containerName` string
    - `podName` string
    - `imageId` string
    - `propsContainer` object
    - `tags` object

## Other responses

- `204` — No Data
- `4XX` — Client Error
- `5XX` — Internal Server Error

---

[API](https://skmtc.net/lacework/apis/forticnapp-api-2-0-documentation.md) · [All operations](https://skmtc.net/lacework/apis/forticnapp-api-2-0-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lacework/forticnapp-api-2-0-documentation/revisions/7015f76895f2/schema)