Protocol Documentation

Name of the app, required.

Image used by the app, required. However, this may only contain the image id if it is returned by ListPods().

State of the app. optional, non-empty only if it's returned by InspectPod().

Exit code of the app. optional, only valid if it's returned by InspectPod() and the app has already exited.

Annotations for this app.

Type of the event, required.

ID of the subject that causes the event, required. If the event is a pod or app event, the id is the pod's uuid. If the event is an image event, the id is the image's id.

Name of the subject that causes the event, required. If the event is a pod event, the name is the pod's name. If the event is an app event, the name is the app's name. If the event is an image event, the name is the image's name.

Timestamp of when the event happens, it is the seconds since epoch, required.

Data of the event, in the form of key-value pairs, optional.

If not empty, then only returns the events that have the listed types.

If not empty, then only returns the events whose 'id' is included in the listed ids.

If not empty, then only returns the events whose 'from' is included in the listed names.

If set, then only returns the events after this timestamp. If the server starts after since_time, then only the events happened after the start of the server will be returned. If since_time is a future timestamp, then no events will be returned until that time.

If set, then only returns the events before this timestamp. If it is a future timestamp, then the event stream will be closed at that moment.

Required.

ID of the pod which we will get logs from, required.

Name of the app within the pod which we will get logs from, optional. If not set, then the logs of all the apps within the pod will be returned.

Number of most recent lines to return, optional.

If true, then a response stream will not be closed, and new log response will be sent via the stream, default is false.

If set, then only the logs after the timestamp will be returned, optional.

If set, then only the logs before the timestamp will be returned, optional.

List of the log lines that returned, optional as the response can contain no logs.

Data directory.

System configuration directory.

Local configuration directory.

User configuration directory.

Insecure flags configurates what security features to disable.

Whether to automatically trust gpg keys fetched from https

Base format of the image, required. This indicates the original format for the image as nowadays all the image formats will be transformed to ACI.

ID of the image, a string that can be used to uniquely identify the image, e.g. sha512 hash of the ACIs, required.

Name of the image in the image manifest, e.g. 'coreos.com/etcd', optional.

Version of the image, e.g. 'latest', '2.0.10', optional.

Timestamp of when the image is imported, it is the seconds since epoch, optional.

JSON-encoded byte array that represents the image manifest, optional.

Size is the size in bytes of this image in the store.

Annotations on this image.

Labels of this image.

If not empty, the images that have any of the ids will be returned.

if not empty, the images that have any of the prefixes in the name will be returned.

If not empty, the images that have any of the base names will be returned. For example, both 'coreos.com/etcd' and 'k8s.io/etcd' will be returned if 'etcd' is included, however 'k8s.io/etcd-backup' will not be returned.

If not empty, the images that have any of the keywords in the name will be returned. For example, both 'kubernetes-etcd', 'etcd:latest' will be returned if 'etcd' is included,

If not empty, the images that have all of the labels will be returned.

If set, the images that are imported after this timestamp will be returned.

If set, the images that are imported before this timestamp will be returned.

If not empty, the images that have all of the annotations will be returned.

If not empty, the images that have any of the exact full names will be returned.

Type of the image, required.

Version of the image format, required.

Version of rkt, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/).

Version of appc, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/).

Latest version of the api that's supported by the service, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/).

The global flags that passed to the rkt api service when it's launched.

Required.

Required.

ID of the pod which we are querying status for, required.

Required.

Key part of the key-value pair.

Value part of the key-value pair.

Optional.

Optional.

Required.

Optional.

Optional.

Required.

Optional.

Aggregate multiple events to reduce round trips, optional as the response can contain no events.

Name of the network that a pod belongs to, required.

Pod's IPv4 address within the network, optional if IPv6 address is given.

Pod's IPv6 address within the network, optional if IPv4 address is given.

ID of the pod, in the form of a UUID.

PID of the stage1 process of the pod.

State of the pod.

List of apps in the pod.

Network information of the pod. Note that a pod can be in multiple networks.

JSON-encoded byte array that represents the pod manifest of the pod.

Annotations on this pod.

Cgroup of the pod, empty if the pod is not running.

Timestamp of when the pod is created, nanoseconds since epoch. Zero if the pod is not created.

Timestamp of when the pod is started, nanoseconds since epoch. Zero if the pod is not started.

Timestamp of when the pod is moved to exited-garbage/garbage, in nanoseconds since epoch. Zero if the pod is not moved to exited-garbage/garbage yet.

If not empty, the pods that have any of the ids will be returned.

If not empty, the pods that have any of the states will be returned.

If not empty, the pods that all of the apps will be returned.

If not empty, the pods that have all of the images(in the apps) will be returned

If not empty, the pods that are in all of the networks will be returned.

If not empty, the pods that have all of the annotations will be returned.

If not empty, the pods whose cgroup are listed will be returned.

If not empty, the pods whose these cgroup belong to will be returned. i.e. the pod's cgroup is a prefix of the specified cgroup