Fetch container details based on the filters passed.

1min

GET
API to get information of all containers of container type based on the filters specified.
HEADER/QUERY PARAMETERDESCRIPTIONTYPEVALIDATION
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.stringDefault value: createdAt
sortBy(query)Fetching data in ascending (asc) or descending (desc) order.stringAvailable values: desc, ascDefault value: desc
containerType*(query)Type of container.string
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
503 - Server ErrorSomething went wrong. (These are rare.)
Path Parameters
containerTypeName
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
limit
integer
offset
integer
size
integer
page
integer
select
string[]
query
Query
sortKey
InstanceSortKey
sortBy
SortBy
Responses
200
OK
ContainersResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
request
Request
401
Unauthorized
ErrorResponse
error
Error
request
Request
404
Not Found
ErrorResponse
error
Error
request
Request
503
Server Error
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerTypeName}/filter' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerTypeName}/filter' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
503
// OK 
{
  "data": {
    "meta": {
      "totalElements": 0
    },
    "containers": [
      ""
    ]
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "meta": {
      "totalElements": 0
    },
    "containers": [
      ""
    ]
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

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, ascDefault 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.)

Updated 24 Aug 2023

Did this page help you?

Update attribute of Container

Fetch details of container by trackingId