Get All Containers
GET {{baseUrl}}/api/v2/containers?filter[tags]=<string>&group_by=<string>&sort=<string>&page[size]=1000&page[cursor]=<string>
Get all containers for your organization.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter[tags] | string | Comma-separated list of tags to filter containers by. | |
group_by | string | Comma-separated list of tags to group containers by. | |
sort | string | Attribute to sort containers by. | |
page[size] | number | Maximum number of results returned. | |
page[cursor] | string | String to query the next page of results. | |
This key is provided with each valid response from the API in meta.pagination.next_cursor. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"container_id":"\u003cstring\u003e","created_at":"\u003cstring\u003e","host":"\u003cstring\u003e","image_digest":"\u003cstring\u003e","image_name":"\u003cstring\u003e","image_tags":["\u003cstring\u003e","\u003cstring\u003e"],"name":"\u003cstring\u003e","started_at":"\u003cstring\u003e","state":"\u003cstring\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"]},"id":"\u003cstring\u003e","type":"container"},{"attributes":{"container_id":"\u003cstring\u003e","created_at":"\u003cstring\u003e","host":"\u003cstring\u003e","image_digest":"\u003cstring\u003e","image_name":"\u003cstring\u003e","image_tags":["\u003cstring\u003e","\u003cstring\u003e"],"name":"\u003cstring\u003e","started_at":"\u003cstring\u003e","state":"\u003cstring\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"]},"id":"\u003cstring\u003e","type":"container"}],"links":{"first":"\u003cstring\u003e","last":"\u003cstring\u003e","next":"\u003cstring\u003e","prev":"\u003cstring\u003e","self":"\u003cstring\u003e"},"meta":{"pagination":{"cursor":"\u003cstring\u003e","limit":"\u003cinteger\u003e","next_cursor":"\u003cstring\u003e","prev_cursor":"\u003cstring\u003e","total":"\u003clong\u003e","type":"cursor_limit"}}}