API to get information of all containers of container type based on the filters specified.
| HEADER/QUERY PARAMETER | DESCRIPTION | TYPE | VALIDATION |
|--- |--- |--- |--- |
| X-COREOS-REQUEST-ID(header) | Unique request ID. | string | |
| X-COREOS-TID (header) | Tenant ID. | string | |
| X-COREOS-ACCESS(header) | Core-OS access token. | string |
|
| limit(query) | Number of items to return. | integer | ㅤDefault value: 50 |
| offset(query) | The number of items to skip from start. | integer | ㅤDefault value: 0 |
| select(query) | Specifies the list of attributes to be included in the response. If not specified, all attributes are included in the response.| array[string] | ㅤAvailable values: name, isSystem,
ㅤisActive, allowedOwner, ttl |
| query(query) | Query criteria. | object | ㅤRefer following links for more details:
ㅤ1. match
ㅤ2. multi_match
ㅤ3. term
ㅤ4. terms
ㅤ5. range
ㅤ6. regexp
ㅤ7. exists
ㅤ8. fuzzy
ㅤ9. prefix
10. wildcard
11. match_phrase
12. match_phrase_prefix |
| sortKey(query) | Key to be used for sorting data. | string | Default value: createdAt |
| sortBy(query) | Fetching data in ascending (asc) or descending (desc) order. | string | Available values: desc, asc
Default value: desc |
| containerType(query) | Type of container. | string |
*This is required.
HTTP Status Code Summary
| Code | Description |
| ---- | ---------- |
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 404 - Not Found | The requested resource doesn't exist. |
| 503 - Server Error | Something went wrong. (These are rare.) |
get https://delhivery.preprod.fxtrt.io/core/api/v2/containers//filter