API to get the list of all container types and their basic details.
Important: Core Attributes Configuration and State Machine Configuration of container types are not included in the response.
| 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 the 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. term
ㅤ3. terms
ㅤ4. range
ㅤ5. regexp
ㅤ6. exists
ㅤ7. 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 | Default value: desc
Available values: desc, asc |
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.) |