edgeEngine mCM API

Get the images

            "data": [
			    {
			      "id": "sha256:4dcab49015d4",
			      "name": "mimik/mdrive/v1",
			      "repoDigests": [
			        [
			          "sha256:4dcab49015d4",
			          "sha256:3c9clb11a52b"
			        ]
			      ],
			      "created": 1505947350,
			      "size": 1024,
			      "containers": 2
			    }
			  ]
			}

newImage *required

object

(body)

the image information

{
  "url": "http://containerregistry.com/example.",
  "base64Image": "string"
}            

Parameter content type

application/json

mode

string

(query)

Switch to toggle from downloading the payload to downloading the reference of the payload.

Available values : payload, reference

Default value : reference

reference

Image created successfully

{
  "url": "http://containerregistry.com/example.",
  "base64Image": "string"
}            

id *required

string

(path)

GUID ot identify the image

id – GUID ot identify the image

Deleted Image Information

{
  "id": "sha256:4dcab49015d4",
  "name": "mimik/mdrive/v1",
  "repoDigests": [
    [
      "sha256:4dcab49015d4",
      "sha256:3c9clb11a52b"
    ]
  ],
  "created": 1505947350,
  "size": 1024,
  "containers": 2
}           

list of containers

{
  "data": [
    {
      "id": "string",
      "image": "string",
      "imageId": "string",
      "created": 0,
      "state": "created",
      "env": [
        "string"
      ]
    }
  ]
}

newContainer *required

object

(body)

the container information

{
  "name": "string",
  "image": "string",
  "env": [
    "string"
  ]
}           

Parameter content type

application/json

New Container Information

{
  "id": "string",
  "image": "string",
  "imageId": "string",
  "created": 0,
  "state": "created",
  "env": [
    "string"
  ]
}           

id *required

string

(path)

GUID ot identify the image

id – GUID ot identify the image

Action *required

object

(body)

the container state

{
  "action": "start"
}          

Parameter content type

application/json

Updated Container Information

{
  "data": {}
}          

id *required

string

(path)

GUID ot identify the image

id – GUID ot identify the image

Deleted Container Information

{
  "id": "string",
  "image": "string",
  "imageId": "string",
  "created": 0,
  "state": "created",
  "env": [
    "string"
  ]
}          

string

A mimik image’s ID is a digest, which contains an SHA256 hash of the image’s JSON configuration object

string

An image name is made up of slash-separated name components, optionally prefixed by a registry hostname. The hostname must comply with standard DNS rules, but may not contain underscores.

an array of filesystem layer of the container

string

integer

the epoch time in second

integer

the size of the image in bytes

integer

the number of containers created from this image

string

A mimik image’s ID is a digest, which contains an SHA256 hash of the image’s JSON configuration object

string

An image name is made up of slash-separated name components, optionally prefixed by a registry hostname. The hostname must comply with standard DNS rules, but may not contain underscores.

an array of filesystem layer of the container

string

integer

the epoch time in second

integer

the size of the image in bytes

integer

the number of containers created from this image

string

A GUID generated by the system

string

The name of the image used

string

The id of the image used

integer

date the container is created. Epoch in seconds

string

the state of container. Valid strings are created|running|removing|paused Please note that in docker they have restarting|exited|dead, but does not make sense in the light container.

Enum:

[ created, running, removing, paused ]

string

[A list of environment variables to set inside the container in the form [“VAR=value”, …]. A variable without = is removed from the environment, rather than to have an empty value. Please note that this properties will be filtered out when make the request because it may contain sensitive data that needs to be used to initialize the container]

string

A GUID generated by the system

string

The name of the image used

string

The id of the image used

integer

date the container is created. Epoch in seconds

string

the state of container. Valid strings are created|running|removing|paused Please note that in docker they have restarting|exited|dead, but does not make sense in the light container.

Enum:

[ created, running, removing, paused ]

string

[A list of environment variables to set inside the container in the form [“VAR=value”, …]. A variable without = is removed from the environment, rather than to have an empty value. Please note that this properties will be filtered out when make the request because it may contain sensitive data that needs to be used to initialize the container]

string

url to retrive the container image

string

a base64 encoded container image

string

Valid strings are start|stop

Enum:

[ start, stop ]

string

name for the container. Please note that Docker allows one to give more than one name to a container.

string

The name of the image to use when creating the container

string

[A list of environment variables to set inside the container in the form [“VAR=value”, …]. A variable without = is removed from the environment, rather than to have an empty value.]