action bluemix_get_containers_json {
  label: "List single containers in a space."
  description: "This endpoint returns a list of all single containers in a space that are currently in a running state (corresponding IBM Containers command: `cf ic ps`). To list all single containers independent of their current state, set the `all` query parameter to true."
  provider: bluemix
  method: GET
  path: "/containers/json"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Auth-Project-Id": {
        type: "string"
      }
      "X-Auth-Token": {
        type: "string"
      }
      all: {
        type: "string"
      }
      filters: {
        type: "string"
      }
    }
    required: ["X-Auth-Project-Id", "X-Auth-Token"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      properties: {
        Command: {
          type: "string"
          description: "The command and arguments that were passed to the container during container creation. This command is executed when the container is started."
        }
        ContainerState: {
          type: "string"
          description: "The current status of the container. The status can either be a transient state, such as BUILDING, and NETWORKING or a non-transient state, such as RUNNING, SHUTDOWN, CRASHED, PAUSED, or SUSPENDED. "
        }
        Created: {
          type: "number"
          format: "float"
          description: "The time when the container was created."
        }
        Env: {
          type: "array"
          description: "A list of all the environment variables of the container."
          items: {
            type: "string"
          }
        }
        Group: {
          properties: {
            Id: {
              type: "string"
              description: "Unique identifier representing a group."
            }
            Name: {
              type: "string"
              description: "Name of the group."
            }
          }
        }
        Id: {
          type: "string"
          description: "Unique identifier representing a container."
        }
        Image: {
          type: "string"
          description: "Full path to the container image in your private Bluemix registry."
        }
        ImageId: {
          type: "string"
          description: "Unique identifier representing a container image."
        }
        Labels: {
          type: "object"
          description: "List of custom metadata that was added to the container. Labels serve a wide range of uses, such as adding notes to a container. Every label is a key/ value pair."
        }
        Memory: {
          type: "integer"
          format: "int32"
          description: "The amount of container memory in Megabyte that was assigned to your container. The memory is counted towards the quota that is allocated for the space."
        }
        Name: {
          type: "string"
          description: "The name of the container. "
        }
        Names: {
          type: "array"
          description: "The name of the container."
          items: {
            type: "string"
          }
        }
        NetworkSettings: {
          required: ["IpAddress", "PublicIpAddress"]
          properties: {
            Bridge: {
              type: "string"
              description: "The name of the private network bridge."
            }
            Gateway: {
              type: "string"
              description: "The IP address of the private network gateway in IPv4 format."
            }
            IpAddress: {
              type: "string"
              description: "The private IP address that is assigned to the container."
            }
            IpPrefixLen: {
              type: "integer"
              format: "int32"
            }
            MacAddress: {
              type: "string"
              description: "The MAC address that was assigned to the container. "
            }
            Network: {
              properties: {
                Aliases: {
                  type: "string"
                  description: "Alternative name of the private container network the container is connected to."
                }
                EndpointID: {
                  type: "string"
                  description: "Unique ID representing a container."
                }
                Gateway: {
                  type: "string"
                  description: "The private IP address of the network gateway in IPv4 format."
                }
                GlobalIPv6Address: {
                  type: "string"
                  description: "Private IP address of the container in IPv6 format. IBM Containers only supports IPv4 format. This attribute is returned as empty."
                }
                GlobalIPv6PrefixLen: {
                  type: "integer"
                  description: "Not supported by IBM Containers, empty string."
                }
                IPAMConfig: {
                  type: "string"
                  description: "Specific configurations for the network driver."
                }
                IPPrefixLen: {
                  type: "string"
                  description: "The prefix of the subnet in the private container network. The prefix indicates that 16 bits out of 32 bits are used to address the network. As every IPv4 IP adress consists of 32 bits, the last 16 bits are used to assign private IP addresses to the container. "
                }
                IPv6Gateway: {
                  type: "string"
                  description: "The private IP address of the network gateway in IPv6 format. IBM Containers only supports IPv4 format. This attribute is returned as empty."
                }
                Links: {
                  type: "string"
                  description: "List of container names that are linked to the container. "
                }
                MacAddress: {
                  type: "string"
                  description: "The MAC address that is assigned to the container."
                }
                NetworkID: {
                  type: "string"
                  description: "Unique identifier representing the private container network."
                }
              }
            }
            PortMapping: {
              type: "string"
              description: "Specific to Docker. List of private container ports and their mapping to the host ports. In IBM Containers all container ports are exposed on the host by default. This attribute is returned as an empty list. "
            }
            Ports: {
              type: "array"
              description: "All ports of the container that were exposed to the public."
              items: {
                type: "string"
              }
            }
            PublicIpAddress: {
              type: "string"
              description: "The Public IP address that was bound to the container."
            }
          }
        }
        Ports: {
          properties: {
            IP: {
              type: "string"
              description: "Public IP address that was bound to the container in IPv4 format."
            }
            PrivatePort: {
              type: "string"
              description: "The private port of the container on which the container listens during run time."
            }
            PublicPort: {
              type: "string"
              description: "The public port that was exposed during container creation. When a public port is exposed, a public IP address can be bound to the container which makes the container accessible from the internet."
            }
            Type: {
              type: "string"
              description: "The type of IP protocol that is used for the port. It can either be `udp` or `tcp`.  "
            }
          }
        }
        SizeRootFs: {
          type: "integer"
          description: "Total size of all the files in the container, in bytes. "
        }
        SizeRw: {
          type: "integer"
          description: "The size of the files which have been created or changed, if you compare the container to its base image. Just after creation, this should be zero. Ass you modify (or create) files, this size will increase."
        }
        Started: {
          type: "number"
          format: "float"
          description: "Time when the container was started."
        }
        Status: {
          type: "string"
          description: "The current status of the container. The status can either be a transient state, such as BUILDING, and NETWORKING or a non-transient state, such as RUNNING, SHUTDOWN, CRASHED, PAUSED, or SUSPENDED"
        }
        VCPU: {
          type: "integer"
          description: "Number of virtual CPUs that are assigned to the container."
        }
      }
    }
  }
}