Fetch details of container

1min

GET
API to get information (base & core attribute values) of a container specified by containerId.
HEADER/PATH/QUERYDESCRIPTIONTYPE
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
containerId*(path)Unique ID of Container.string
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
containerId
string
*
Unique id of Container
containerTypeName
string
*
Example: bag
A unique name to represent type of a container.
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique request id.
X-COREOS-TID
string
*
Example: delhivery1234
Tenant id
X-COREOS-ACCESS
string
*
Core-os access token
X-COREOS-USERINFO
string
Core-os user info
RESPONSES
200
OK
ContainerResponse
data
ContainerByIdResponseData
request
Request
400
Bad Request
ErrorResponse
error
Error
Error Information
request
Request
401
Unauthorized
ErrorResponse
error
Error
Error Information
request
Request
404
Not Found
ErrorResponse
error
Error
Error Information
request
Request
503
Server Error
ErrorResponse
error
Error
Error Information
request
Request
﻿
﻿

HEADER/PATH/QUERY	DESCRIPTION	TYPE
`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

`containerId`*(path)	Unique ID of Container.	string
`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?

containerization/decontainerization of the container

Update attribute of Container