action bluemix_get_containers_name_or_id_json {
  label: "Inspect a single container"
  description: "This endpoint retrieves detailed information about a single container (corresponding IBM Containers command: `cf ic inspect <container>`)."
  provider: bluemix
  method: GET
  path: "/containers/{name_or_id}/json"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Auth-Project-Id": {
        type: "string"
      }
      "X-Auth-Token": {
        type: "string"
      }
      name_or_id: {
        type: "string"
      }
    }
    required: ["X-Auth-Project-Id", "X-Auth-Token", "name_or_id"]
    additionalProperties: false
  }
  output: {
    properties: {
      BluemixApp: {
        type: "string"
        description: "The name of the Cloud Foundry app that was bound to the container during creation."
      }
      BluemixServices: {
        type: "string"
        description: "The name of the Bluemix service instance that was bound to the container during creation."
      }
      Config: {
        properties: {
          ArgsEscaped: {
            type: "boolean"
          }
          AttachStderr: {
            type: "string"
            description: "Attaches the container to stderr."
          }
          AttachStdin: {
            type: "string"
            description: "Attaches the container to sdtin."
          }
          AttachStdout: {
            type: "string"
            description: "Attaches the container to stdout."
          }
          Cmd: {
            type: "array"
            description: "The command and arguments in this list are passed to the container to be executed when the container is started. This command must be a long-running command. Do not use a short-lived command, for example, /bin/date, because it might cause the container to crash. <br>Sample long-running commands:<br>[\"ping\",\"localhost\"]<br>[\"tail\",\"-f\",\"/dev/null\"]<br>[\"sh\",\"-c\",\"while true; do date; sleep 20; done\"]\n"
            items: {
              type: "string"
            }
          }
          Domainname: {
            type: "string"
            description: "The domain name to be used for the container."
          }
          Env: {
            type: "array"
            description: "A list of environment variables in the form of key=value pairs. All keys in this list have to be unique. List multiple keys separately and if you include quotation marks, include them around both the environment variable name and the value."
            items: {
              type: "string"
            }
          }
          ExposedPorts: {
            type: "array"
            description: "List of public ports that were exposed during container creation. "
            items: {
              type: "string"
            }
          }
          Hostname: {
            type: "string"
            description: "The host name to be used for the container."
          }
          Image: {
            type: "string"
            description: "Full path to the image that the container is based on in your private Bluemix registry."
          }
          ImageArchitecture: {
            type: "string"
            description: "The hardware architecture the image is based on. It can either be 'amd64' indicating an Intel-based architecture, or 'ppc64le' representing a Power-based architecture."
          }
          Labels: {
            type: "array"
            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."
            items: {
              type: "string"
            }
          }
          Memory: {
            type: "integer"
            format: "int32"
            description: "The amount of container memory that is assigned to the container in Megabyte."
          }
          MemorySwap: {
            type: "string"
            description: "The total container memory limit (memory + swap)"
          }
          OpenStdin: {
            type: "string"
            description: "When set to true, it opens stdin. "
          }
          PortSpecs: {
            type: "string"
            description: "Not supported by IBM Containers, empty string."
          }
          StdinOnce: {
            type: "string"
            description: "When set to true it closes stdin after the attached client disconnects."
          }
          Tty: {
            type: "string"
            description: "When set to true, attach standard streams to a tty, including stdin if it is not closed."
          }
          User: {
            type: "string"
            description: "User to be used inside the container."
          }
          VCPU: {
            type: "integer"
            format: "int32"
            description: "Number of virtual CPUs that are assigned to the container."
          }
          VolumesFrom: {
            type: "string"
            description: "List of volumes to inherit from another container. This feature is not supported in IBM Containers."
          }
          WorkingDir: {
            type: "string"
            description: "The working directory inside the container where specified commands are executed. "
          }
        }
      }
      ContainerState: {
        type: "string"
        description: "The current status of the container. This state can either be transient, such as BUILDING or NETWORKING, or non-transient, such as RUNNING, SHUTDOWN, CRASHED, or SUSPENDED."
      }
      Created: {
        type: "string"
        format: "date-time"
        description: "The date and time the container was created."
      }
      Group: {
        properties: {
          Id: {
            type: "string"
            description: "Unique identifier representing a group."
          }
          Name: {
            type: "string"
            description: "Name of the group."
          }
        }
      }
      HostConfig: {
        type: "object"
        properties: {
          Binds: {
            type: "array"
            description: "A list of volumes to be bound to the container. Each volume must be listed in the following format: VOLNAME:/CONTAINER_PATH:rw [ro]. "
            items: {
              type: "string"
            }
          }
          ExtraHosts: {
            type: "array"
            description: "A list of hostnames/IP mappings to be added to the container’s /etc/hosts file. Specified in the form [\"hostname:IP\"]\n"
            items: {
              type: "string"
            }
          }
          Links: {
            type: "array"
            description: "A list of containers that need to be linked."
            items: {
              type: "string"
            }
          }
          PortBindings: {
            type: "array"
            description: "The container ports that you want to expose to the public. Ports need to be specified in the form of &lt;port&gt;/&lt;protocol&gt;: [{ \"HostIp\": \"&lt;IP&gt;\", \"HostPort\": \"&lt;port&gt;\" }]\n"
            items: {
              type: "string"
            }
          }
        }
      }
      HostId: {
        type: "string"
        description: "The ID representing the physical compute host."
      }
      Human_Id: {
        type: "string"
        description: "The name of the container. "
      }
      Id: {
        type: "string"
        description: "Unique identifier representing a container."
      }
      Image: {
        type: "string"
        description: "Unique identifier representing a container image."
      }
      Mounts: {
        type: "array"
        description: "A list of volumes that are mounted to the container."
        items: {
          type: "string"
        }
      }
      Name: {
        type: "string"
        description: "The name of the container."
      }
      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."
          }
        }
      }
      Path: {
        type: "string"
        description: "The environment variable indicating the binary location."
      }
      ResolveConfPath: {
        type: "string"
        description: "Path to the resolve.conf file inside the container. The resolve.conf file is used to resolve the DNS servers."
      }
      State: {
        properties: {
          ExitCode: {
            type: "string"
            description: "The exit code indicating the root cause of why the container exited. Review the Docker API documentation to find a list of exit codes and their meaning. "
          }
          FinishedAt: {
            type: "string"
            description: "Time when the container stopped."
          }
          Ghost: {
            type: "string"
            description: "Not supported by IBM Containers, empty string"
          }
          Pid: {
            type: "integer"
            description: "The process ID on the compute host that runs the container process."
          }
          Running: {
            type: "boolean"
            description: "If set to true, the container is in a RUNNING state. If set to false, the container has stopped or crashed. "
          }
          StartedAt: {
            type: "string"
            description: "Time when the container started."
          }
          Status: {
            type: "string"
            description: "The current status of the container. This state can either be transient, such as BUILDING or NETWORKING, or non-transient, such as RUNNING, SHUTDOWN, CRASHED, or SUSPENDED."
          }
        }
      }
      Volumes: {
        properties: {
          fsID: {
            type: "string"
            description: " Unique identifier representing the file share on which the volume is hosted. "
          }
          hostPath: {
            type: "string"
            description: "Full path to the mounted volume inside the container."
          }
          otherSpaceVisibility: {
            type: "array"
            description: "List of space IDs in which the volume is visible and can be used by all the single containers and container groups. "
            items: {
              type: "string"
            }
          }
          spaceGuid: {
            type: "string"
            description: "Unique identifier representing the space where the volume got created."
          }
          volName: {
            type: "string"
            description: "The name of the volume."
          }
        }
      }
      VolumesRW: {
        type: "array"
        description: "LIst of volumes that is mounted to the container."
        items: {
          type: "string"
        }
      }
    }
  }
}