containerization/decontainerization of the container

1min

PUT
Grouping together container into a container. The container that goes inside another container is said to be containerized.
containerId - The child container ID that needs to be add in parent container.
parentId - The parent container ID that needs to be add as parent of a container.
action - field to represent action to be performed on the container.
PARAMETERDESCRIPTIONTYPEVALIDATION
parentId*Field to represent container ID of the parent container. During the containerization process, this value is assigned to represent which container contains this container.stringExample- box:9c9b1138-7cdd-11eb-9439-0242ac130002
action*field to represent action to be performed on the container.field to represent action to be performed on the container.
callbackRepresents callback URL, which can be to notify status(success/failed) of API.stringA valid URL.
*This is required.
HTTP Status Code Summary
CodeDescription
202 - Accepted
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
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
ParentIdRequest
*
Description
parent id
parentId
string
*
action
string<CONTAINERIZE | DECONTAINERIZE>
*
Responses
202
Containerization or decontainerization
ChildContainerResponse
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 --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerId}/child' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "parentId": "",
  "action": ""
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerId}/child' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "parentId": "",
  "action": ""
}'
Responses
202
400
401
404
503
// Containerization or decontainerization 
{
  "data": {
    "id": "",
    "operation": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Containerization or decontainerization 
{
  "data": {
    "id": "",
    "operation": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

PARAMETER	DESCRIPTION	TYPE	VALIDATION
`parentId`*	Field to represent container ID of the parent container. During the containerization process, this value is assigned to represent which container contains this container.	string	Example- box:9c9b1138-7cdd-11eb-9439-0242ac130002
`action`*	field to represent action to be performed on the container.field to represent action to be performed on the container.
`callback`	Represents callback URL, which can be to notify status(success/failed) of API.	string	A valid URL.
*This is required.

HTTP Status Code Summary

Code	Description
202 - Accepted
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?

Fetch details of container by trackingId

containerization/decontainerization of the container