Get the current state of a container

1min

GET
API to get the current state of a container.
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
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
*
containerTypeName
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
OK
ContainerStateResponse
data
ContainerState
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}/{containerId}/state' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerTypeName}/{containerId}/state' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
503
// OK 
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-556642440000"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-556642440000"
  },
  "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
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?

Apply event on the container.