Add containers to a group

1min

POST
API to group a list of containers.
HEADER/PATHDESCRIPTIONTYPE
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|
*This is required.

HTTP Status Code Summary
CodeDescription
202 - AcceptedEverything 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.)
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
ContainerGroupCreateRequest
*
Description
Group containers request.
groupId
string
*
containerIds
string[]
*
containerType
string
*
callback
object
Responses
202
ACCEPTED
ContainerGroupResponse
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/container-group/group' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "groupId": "",
  "containerIds": [
    ""
  ],
  "containerType": ""
}'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/container-group/group' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "groupId": "",
  "containerIds": [
    ""
  ],
  "containerType": ""
}'
Responses
202
400
401
404
503
// ACCEPTED 
{
  "data": {
    "groupId": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// ACCEPTED 
{
  "data": {
    "groupId": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

HEADER/PATH	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

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

Apply event on the container.

Remove containers from a group