Provides a container compatible interface.

Documentation Powered by ReDoc

# Provides a container compatible interface. (0.0.1)

Download OpenAPI specification:Download

Podman: podman@lists.podman.io URL: https://podman.io/community/ License: Apache-2.0

This documentation describes the Podman v2.0 RESTful API. It replaces the Podman v1.0 API and was initially delivered along with Podman v2.0. It consists of a Docker-compatible API and a Libpod API providing support for Podman’s unique features such as pods.

To start the service and keep it running for 5,000 seconds (-t 0 runs forever):

podman system service -t 5000 &

You can then use cURL on the socket using requests documented below.

NOTE: if you install the package podman-docker, it will create a symbolic link for /run/docker.sock to /run/podman/podman.sock

See podman-service(1) for more information.

Quick Examples:

'podman info'

curl --unix-socket /run/podman/podman.sock http://d/v1.0.0/libpod/info

'podman pull quay.io/containers/podman'

curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman'

'podman list images'

curl --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/libpod/images/json' | jq

# containers

Actions related to containers

## Commit

Create a new image from a container

##### query Parameters

container required | string the name or ID of a container
repo | string the repository name for the created image
tag | string tag name for the created image
comment | string commit message
author | string author of the image
pause | boolean pause the container before committing it
changes | Array of strings instructions to apply while committing in Dockerfile format (i.e. "CMD=/bin/foo")
format | string format of the image manifest and metadata (default "oci")

### Responses

http://podman.io/libpod/commit
https://podman.io/libpod/commit

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Run a container's healthcheck

Execute the defined healthcheck and return information about the results

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name:.*}/healthcheck
https://podman.io/libpod/containers/{name:.*}/healthcheck

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "FailingStreak": 0,
- "Log":
  [
  - {
    - "End": "string",
    - "ExitCode": 0,
    - "Output": "string",
    - "Start": "string"
    }
  ],
- "Status": "string"

}`

## Delete container

Delete container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

force | boolean need something
v | boolean delete volumes

### Responses

http://podman.io/libpod/containers/{name}
https://podman.io/libpod/containers/{name}

### Response samples

- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Copy files into a container

Copy a tar archive of files into a container

##### path Parameters

name required | string container name or id

##### query Parameters

path required | string Path to a directory in the container to extract
pause | boolean Default: true pause the container while copying (defaults to true)

##### Request Body schema:
application/json
application/json
application/x-tar

tarfile of files to copy into the container

string

### Responses

http://podman.io/libpod/containers/{name}/archive
https://podman.io/libpod/containers/{name}/archive

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`"string"`

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Attach to a container

Hijacks the connection to forward the container's standard streams to the client.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

detachKeys | string keys to use for detaching from the container
logs | boolean Stream all logs from the container across the connection. Happens before streaming attach (if requested). At least one of logs or stream must be set
stream | boolean Default: true Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least one of stream or logs must be set
stdout | boolean Attach to container STDOUT
stderr | boolean Attach to container STDERR
stdin | boolean Attach to container STDIN

### Responses

http://podman.io/libpod/containers/{name}/attach
https://podman.io/libpod/containers/{name}/attach

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Report on changes to container's filesystem; adds, deletes or modifications.

Returns which files in a container's filesystem have been added, deleted, or modified. The Kind of modification can be one of:

0: Modified 1: Added 2: Deleted

##### path Parameters

name required | string the name or id of the container

### Responses

http://podman.io/libpod/containers/{name}/changes
https://podman.io/libpod/containers/{name}/changes

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Checkpoint a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

keep | boolean keep all temporary checkpoint files
leaveRunning | boolean leave the container running after writing checkpoint to disk
tcpEstablished | boolean checkpoint a container with established TCP connections
export | boolean export the checkpoint image to a tar.gz
ignoreRootFS | boolean do not include root file-system changes when exporting

### Responses

http://podman.io/libpod/containers/{name}/checkpoint
https://podman.io/libpod/containers/{name}/checkpoint

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Check if container exists

Quick way to determine if a container exists by name or ID

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/exists
https://podman.io/libpod/containers/{name}/exists

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Export a container

Export the contents of a container as a tarball.

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/export
https://podman.io/libpod/containers/{name}/export

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Initialize a container

Performs all tasks necessary for initializing the container but does not start the container.

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/init
https://podman.io/libpod/containers/{name}/init

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect container

Return low-level information about a container.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

size | boolean display filesystem usage

### Responses

http://podman.io/libpod/containers/{name}/json
https://podman.io/libpod/containers/{name}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "AppArmorProfile": "string",
- "Args":
  [
  - "string"
  ],
- "BoundingCaps":
  [
  - "string"
  ],
- "Config":
  {
  - "Annotations":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "AttachStderr": true,
  - "AttachStdin": true,
  - "AttachStdout": true,
  - "Cmd":
    [
    - "string"
    ],
  - "CreateCommand":
    [
    - "string"
    ],
  - "Domainname": "string",
  - "Entrypoint": "string",
  - "Env":
    [
    - "string"
    ],
  - "Healthcheck":
    {
    - "Interval": 0,
    - "Retries": 0,
    - "StartPeriod": 0,
    - "Test":
      [
      - "string"
      ],
    - "Timeout": 0
    },
  - "Hostname": "string",
  - "Image": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "OnBuild": "string",
  - "OpenStdin": true,
  - "StdinOnce": true,
  - "StopSignal": 0,
  - "SystemdMode": true,
  - "Timezone": "string",
  - "Tty": true,
  - "Umask": "string",
  - "User": "string",
  - "Volumes":
    {
    - "property1": { },
    - "property2": { }
    },
  - "WorkingDir": "string"
  },
- "ConmonPidFile": "string",
- "Created": "2019-08-24T14:15:22Z",
- "Dependencies":
  [
  - "string"
  ],
- "Driver": "string",
- "EffectiveCaps":
  [
  - "string"
  ],
- "ExecIDs":
  [
  - "string"
  ],
- "ExitCommand":
  [
  - "string"
  ],
- "GraphDriver":
  {
  - "Data":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string"
  },
- "HostConfig":
  {
  - "AutoRemove": true,
  - "Binds":
    [
    - "string"
    ],
  - "BlkioDeviceReadBps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioDeviceReadIOps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioDeviceWriteBps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioDeviceWriteIOps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioWeight": 0,
  - "BlkioWeightDevice":
    [
    - {
      - "Path": "string",
      - "Weight": 0
      }
    ],
  - "CapAdd":
    [
    - "string"
    ],
  - "CapDrop":
    [
    - "string"
    ],
  - "Cgroup": "string",
  - "CgroupConf":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "CgroupManager": "string",
  - "CgroupMode": "string",
  - "CgroupParent": "string",
  - "Cgroups": "string",
  - "ConsoleSize":
    [
    - 0
    ],
  - "ContainerIDFile": "string",
  - "CpuCount": 0,
  - "CpuPercent": 0,
  - "CpuPeriod": 0,
  - "CpuQuota": 0,
  - "CpuRealtimePeriod": 0,
  - "CpuRealtimeRuntime": 0,
  - "CpuShares": 0,
  - "CpusetCpus": "string",
  - "CpusetMems": "string",
  - "Devices":
    [
    - {
      - "CgroupPermissions": "string",
      - "PathInContainer": "string",
      - "PathOnHost": "string"
      }
    ],
  - "DiskQuota": 0,
  - "Dns":
    [
    - "string"
    ],
  - "DnsOptions":
    [
    - "string"
    ],
  - "DnsSearch":
    [
    - "string"
    ],
  - "ExtraHosts":
    [
    - "string"
    ],
  - "GroupAdd":
    [
    - "string"
    ],
  - "IOMaximumBandwidth": 0,
  - "IOMaximumIOps": 0,
  - "Init": true,
  - "IpcMode": "string",
  - "Isolation": "string",
  - "KernelMemory": 0,
  - "Links":
    [
    - "string"
    ],
  - "LogConfig":
    {
    - "Config":
      {
      - "property1": "string",
      - "property2": "string"
      },
    - "Path": "string",
    - "Size": "string",
    - "Tag": "string",
    - "Type": "string"
    },
  - "Memory": 0,
  - "MemoryReservation": 0,
  - "MemorySwap": 0,
  - "MemorySwappiness": 0,
  - "NanoCpus": 0,
  - "NetworkMode": "string",
  - "OomKillDisable": true,
  - "OomScoreAdj": 0,
  - "PidMode": "string",
  - "PidsLimit": 0,
  - "PortBindings":
    {
    - "property1":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ],
    - "property2":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ]
    },
  - "Privileged": true,
  - "PublishAllPorts": true,
  - "ReadonlyRootfs": true,
  - "RestartPolicy":
    {
    - "MaximumRetryCount": 0,
    - "Name": "string"
    },
  - "Runtime": "string",
  - "SecurityOpt":
    [
    - "string"
    ],
  - "ShmSize": 0,
  - "Tmpfs":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "UTSMode": "string",
  - "Ulimits":
    [
    - {
      - "Hard": 0,
      - "Name": "string",
      - "Soft": 0
      }
    ],
  - "UsernsMode": "string",
  - "VolumeDriver": "string",
  - "VolumesFrom":
    [
    - "string"
    ]
  },
- "HostnamePath": "string",
- "HostsPath": "string",
- "Id": "string",
- "Image": "string",
- "ImageName": "string",
- "IsInfra": true,
- "MountLabel": "string",
- "Mounts":
  [
  - {
    - "Destination": "string",
    - "Driver": "string",
    - "Mode": "string",
    - "Name": "string",
    - "Options":
      [
      - "string"
      ],
    - "Propagation": "string",
    - "RW": true,
    - "Source": "string",
    - "Type": "string"
    }
  ],
- "Name": "string",
- "Namespace": "string",
- "NetworkSettings":
  {
  - "AdditionalMACAddresses":
    [
    - "string"
    ],
  - "Bridge": "string",
  - "EndpointID": "string",
  - "Gateway": "string",
  - "GlobalIPv6Address": "string",
  - "GlobalIPv6PrefixLen": 0,
  - "HairpinMode": true,
  - "IPAddress": "string",
  - "IPPrefixLen": 0,
  - "IPv6Gateway": "string",
  - "LinkLocalIPv6Address": "string",
  - "LinkLocalIPv6PrefixLen": 0,
  - "MacAddress": "string",
  - "Networks":
    {
    - "property1":
      {
      - "AdditionalMACAddresses":
        [
        - "string"
        ],
      - "Aliases":
        [
        - "string"
        ],
      - "DriverOpts":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "EndpointID": "string",
      - "Gateway": "string",
      - "GlobalIPv6Address": "string",
      - "GlobalIPv6PrefixLen": 0,
      - "IPAMConfig":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "IPAddress": "string",
      - "IPPrefixLen": 0,
      - "IPv6Gateway": "string",
      - "Links":
        [
        - "string"
        ],
      - "MacAddress": "string",
      - "NetworkID": "string",
      - "SecondaryIPAddresses":
        [
        - "string"
        ],
      - "SecondaryIPv6Addresses":
        [
        - "string"
        ]
      },
    - "property2":
      {
      - "AdditionalMACAddresses":
        [
        - "string"
        ],
      - "Aliases":
        [
        - "string"
        ],
      - "DriverOpts":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "EndpointID": "string",
      - "Gateway": "string",
      - "GlobalIPv6Address": "string",
      - "GlobalIPv6PrefixLen": 0,
      - "IPAMConfig":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "IPAddress": "string",
      - "IPPrefixLen": 0,
      - "IPv6Gateway": "string",
      - "Links":
        [
        - "string"
        ],
      - "MacAddress": "string",
      - "NetworkID": "string",
      - "SecondaryIPAddresses":
        [
        - "string"
        ],
      - "SecondaryIPv6Addresses":
        [
        - "string"
        ]
      }
    },
  - "Ports":
    {
    - "property1":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ],
    - "property2":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ]
    },
  - "SandboxID": "string",
  - "SandboxKey": "string",
  - "SecondaryIPAddresses":
    [
    - "string"
    ],
  - "SecondaryIPv6Addresses":
    [
    - "string"
    ]
  },
- "OCIConfigPath": "string",
- "OCIRuntime": "string",
- "Path": "string",
- "Pod": "string",
- "ProcessLabel": "string",
- "ResolvConfPath": "string",
- "RestartCount": 0,
- "Rootfs": "string",
- "SizeRootFs": 0,
- "SizeRw": 0,
- "State":
  {
  - "ConmonPid": 0,
  - "Dead": true,
  - "Error": "string",
  - "ExitCode": 0,
  - "FinishedAt": "2019-08-24T14:15:22Z",
  - "Healthcheck":
    {
    - "FailingStreak": 0,
    - "Log":
      [
      - {
        - "End": "string",
        - "ExitCode": 0,
        - "Output": "string",
        - "Start": "string"
        }
      ],
    - "Status": "string"
    },
  - "OOMKilled": true,
  - "OciVersion": "string",
  - "Paused": true,
  - "Pid": 0,
  - "Restarting": true,
  - "Running": true,
  - "StartedAt": "2019-08-24T14:15:22Z",
  - "Status": "string"
  },
- "StaticDir": "string"

}`

## Kill container

send a signal to a container, defaults to killing the container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

signal | string Default: "TERM" signal to be sent to container, either by integer or SIG_ name

### Responses

http://podman.io/libpod/containers/{name}/kill
https://podman.io/libpod/containers/{name}/kill

### Response samples

- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get container logs

Get stdout and stderr logs from a container.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

follow | boolean Keep connection after returning logs.
stdout | boolean Return logs from stdout
stderr | boolean Return logs from stderr
since | string Only return logs since this time, as a UNIX timestamp
until | string Only return logs before this time, as a UNIX timestamp
timestamps | boolean Default: false Add timestamps to every log line
tail | string Default: "all" Only return this number of log lines from the end of the logs

### Responses

http://podman.io/libpod/containers/{name}/logs
https://podman.io/libpod/containers/{name}/logs

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Mount a container

Mount a container to the filesystem

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/mount
https://podman.io/libpod/containers/{name}/mount

### Response samples

- 200
- 404
- 500

Content type
application/json
`"/var/lib/containers/storage/overlay/f3f693bd88872a1e3193f4ebb925f4c282e8e73aadb8ab3e7492754dda3a02a4/merged"`

## Pause a container

Use the cgroups freezer to suspend all processes in a container.

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/pause
https://podman.io/libpod/containers/{name}/pause

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Rename an existing container

Change the name of an existing container.

##### path Parameters

name required | string Full or partial ID or full name of the container to rename

##### query Parameters

name required | string New name for the container

### Responses

http://podman.io/libpod/containers/{name}/rename
https://podman.io/libpod/containers/{name}/rename

### Response samples

- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Resize a container's TTY

Resize the terminal attached to a container (for use with Attach).

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

h | integer Height to set for the terminal, in characters
w | integer Width to set for the terminal, in characters

### Responses

http://podman.io/libpod/containers/{name}/resize
https://podman.io/libpod/containers/{name}/resize

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`{ }`

## Restart a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

t | integer timeout before sending kill signal to container

### Responses

http://podman.io/libpod/containers/{name}/restart
https://podman.io/libpod/containers/{name}/restart

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Restore a container

Restore a container from a checkpoint.

##### path Parameters

name required | string the name or id of the container

##### query Parameters

name | string the name of the container when restored from a tar. can only be used with import
keep | boolean keep all temporary checkpoint files
leaveRunning | boolean leave the container running after writing checkpoint to disk
tcpEstablished | boolean checkpoint a container with established TCP connections
import | boolean import the restore from a checkpoint tar.gz
ignoreRootFS | boolean do not include root file-system changes when exporting
ignoreStaticIP | boolean ignore IP address if set statically
ignoreStaticMAC | boolean ignore MAC address if set statically

### Responses

http://podman.io/libpod/containers/{name}/restore
https://podman.io/libpod/containers/{name}/restore

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Start a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

detachKeys | string Default: "ctrl-p,ctrl-q" Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _.

### Responses

http://podman.io/libpod/containers/{name}/start
https://podman.io/libpod/containers/{name}/start

### Response samples

- 304
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get stats for a container

DEPRECATED. This endpoint will be removed with the next major release. Please use /libpod/containers/stats instead.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

stream | boolean Default: true Stream the output

### Responses

http://podman.io/libpod/containers/{name}/stats
https://podman.io/libpod/containers/{name}/stats

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Stop a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

t | integer number of seconds to wait before killing container

### Responses

http://podman.io/libpod/containers/{name}/stop
https://podman.io/libpod/containers/{name}/stop

### Response samples

- 304
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## List processes

List processes running inside a container

##### path Parameters

name required | string Name of container to query for processes (As of version 1.xx)

##### query Parameters

stream | boolean Default: true Stream the output
ps_args | string Default: "-ef" arguments to pass to ps such as aux. Requires ps(1) to be installed in the container if no ps(1) compatible AIX descriptors are used.

### Responses

http://podman.io/libpod/containers/{name}/top
https://podman.io/libpod/containers/{name}/top

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Processes":
  [
  - [
    - "string"
    ]
  ],
- "Titles":
  [
  - "string"
  ]

}`

## Unmount a container

Unmount a container from the filesystem

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/unmount
https://podman.io/libpod/containers/{name}/unmount

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Unpause Container

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/libpod/containers/{name}/unpause
https://podman.io/libpod/containers/{name}/unpause

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Wait on a container

Wait on a container to met a given condition

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

condition | string wait until container is to a given condition. default is stopped. valid conditions are: configured created exited paused running stopped

### Responses

http://podman.io/libpod/containers/{name}/wait
https://podman.io/libpod/containers/{name}/wait

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Error":
  {
  - "Message": "string"
  },
- "StatusCode": 0

}`

## Create a container

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for creating a container

| object Aliases are a list of network-scoped aliases for container Optional
| object Annotations are key-value options passed into the container runtime that can be used to trigger special behavior. Optional.
apparmor_profile | string ApparmorProfile is the name of the Apparmor profile the container will use. Optional.
cap_add | Array of strings CapAdd are capabilities which will be added to the container. Conflicts with Privileged. Optional.
cap_drop | Array of strings CapDrop are capabilities which will be removed from the container. Conflicts with Privileged. Optional.
cgroup_parent | string CgroupParent is the container's CGroup parent. If not set, the default for the current cgroup driver will be used. Optional.
| object (Namespace) Namespace describes the namespace
cgroups_mode | string CgroupsMode sets a policy for how cgroups will be created in the container, including the ability to disable creation entirely.
cni_networks | Array of strings CNINetworks is a list of CNI networks to join the container to. If this list is empty, the default CNI network will be joined instead. If at least one entry is present, we will not join the default network (unless it is part of this list). Only available if NetNS is set to bridge. Optional.
command | Array of strings Command is the container's command. If not given and Image is specified, this will be populated by the image's configuration. Optional.
conmon_pid_file | string ConmonPidFile is a path at which a PID file for Conmon will be placed. If not given, a default location will be used. Optional.
containerCreateCommand | Array of strings ContainerCreateCommand is the command that was used to create this container. This will be shown in the output of Inspect() on the container, and may also be used by some tools that wish to recreate the container (e.g. `podman generate systemd --new`). Optional.
| Array of objects (LinuxDevice) Devices are devices that will be added to the container. Optional.
dns_option | Array of strings DNSOptions is a set of DNS options that will be used in the container's resolv.conf, replacing the host's DNS options which are used by default. Conflicts with UseImageResolvConf. Optional.
dns_search | Array of strings DNSSearch is a set of DNS search domains that will be used in the container's resolv.conf, replacing the host's DNS search domains which are used by default. Conflicts with UseImageResolvConf. Optional.
dns_server | Array of Array of integers (An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.) DNSServers is a set of DNS servers that will be used in the container's resolv.conf, replacing the host's DNS Servers which are used by default. Conflicts with UseImageResolvConf. Optional.
entrypoint | Array of strings Entrypoint is the container's entrypoint. If not given and Image is specified, this will be populated by the image's configuration. Optional.
| object Env is a set of environment variables that will be set in the container. Optional.
env_host | boolean EnvHost indicates that the host environment should be added to container Optional.
expose | any Expose is a number of ports that will be forwarded to the container if PublishExposedPorts is set. Expose is a map of uint16 (port number) to a string representing protocol. Allowed protocols are "tcp", "udp", and "sctp", or some combination of the three separated by commas. If protocol is set to "" we will assume TCP. Only available if NetNS is set to Bridge or Slirp, and PublishExposedPorts is set. Optional.
groups | Array of strings Groups are a list of supplemental groups the container's user will be granted access to. Optional.
| object (Schema2HealthConfig) Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
hostadd | Array of strings HostAdd is a set of hosts which will be added to the container's etc/hosts file. Conflicts with UseImageHosts. Optional.
hostname | string Hostname is the container's hostname. If not set, the hostname will not be modified (if UtsNS is not private) or will be set to the container ID (if UtsNS is private). Conflicts with UtsNS if UtsNS is not set to private. Optional.
httpproxy | boolean EnvHTTPProxy indicates that the http host proxy environment variables should be added to container Optional.
| object (IDMappingOptions) IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
image | string Image is the image the container will be based on. The image will be used as the container's root filesystem, and its environment vars, volumes, and other configuration will be applied to the container. Conflicts with Rootfs. At least one of Image or Rootfs must be specified.
image_volume_mode | string ImageVolumeMode indicates how image volumes will be created. Supported modes are "ignore" (do not create), "tmpfs" (create as tmpfs), and "anonymous" (create as anonymous volumes). The default if unset is anonymous. Optional.
| Array of objects (ImageVolume) Image volumes bind-mount a container-image mount into the container. Optional.
init | boolean Init specifies that an init binary will be mounted into the container, and will be used as PID1.
init_path | string InitPath specifies the path to the init binary that will be added if Init is specified above. If not specified, the default set in the Libpod config will be used. Ignored if Init above is not set. Optional.
| object (Namespace) Namespace describes the namespace
| object Labels are key-value pairs that are used to add metadata to containers. Optional.
| object (LogConfig) LogConfig describes the logging characteristics for a container
mask | Array of strings Mask is the path we want to mask in the container. This masks the paths given in addition to the default list. Optional
| Array of objects (Mount specifies a mount for a container.) Mounts are mounts that will be added to the container. These will supersede Image Volumes and VolumesFrom volumes where there are conflicts. Optional.
name | string Name is the name the container will be given. If no name is provided, one will be randomly generated. Optional.
namespace | string Namespace is the libpod namespace the container will be placed in. Optional.
| object (Namespace) Namespace describes the namespace
| object NetworkOptions are additional options for each network Optional.
no_new_privileges | boolean NoNewPrivileges is whether the container will set the no new privileges flag on create, which disables gaining additional privileges (e.g. via setuid) in the container.
oci_runtime | string OCIRuntime is the name of the OCI runtime that will be used to create the container. If not specified, the default will be used. Optional.
oom_score_adj | integer <int64> OOMScoreAdj adjusts the score used by the OOM killer to determine processes to kill for the container's process. Optional.
| Array of objects (OverlayVolume) Overlay volumes are named volumes that will be added to the container. Optional.
| object (Namespace) Namespace describes the namespace
pod | string Pod is the ID of the pod the container will join. Optional.
| Array of objects (PortMapping is one or more ports that will be mapped into the container.) PortBindings is a set of ports to map into the container. Only available if NetNS is set to bridge or slirp. Optional.
privileged | boolean Privileged is whether the container is privileged. Privileged does the following: Adds all devices on the system to the container. Adds all capabilities to the container. Disables Seccomp, SELinux, and Apparmor confinement. (Though SELinux can be manually re-enabled). TODO: this conflicts with things. TODO: this does more.
procfs_opts | Array of strings ProcOpts are the options used for the proc mount.
publish_image_ports | boolean PublishExposedPorts will publish ports specified in the image to random unused ports (guaranteed to be above 1024) on the host. This is based on ports set in Expose below, and any ports specified by the Image (if one is given). Only available if NetNS is set to Bridge or Slirp.
| Array of objects (POSIXRlimit) Rlimits are POSIX rlimits to apply to the container. Optional.
raw_image_name | string RawImageName is the user-specified and unprocessed input referring to a local or a remote image.
read_only_filesystem | boolean ReadOnlyFilesystem indicates that everything will be mounted as read-only
remove | boolean Remove indicates if the container should be removed once it has been started and exits
| object (LinuxResources) LinuxResources has container runtime resource constraints
restart_policy | string RestartPolicy is the container's restart policy - an action which will be taken when the container exits. If not given, the default policy, which does nothing, will be used. Optional.
restart_tries | integer <uint64> RestartRetries is the number of attempts that will be made to restart the container. Only available when RestartPolicy is set to "on-failure". Optional.
rootfs | string Rootfs is the path to a directory that will be used as the container's root filesystem. No modification will be made to the directory, it will be directly mounted into the container as root. Conflicts with Image. At least one of Image or Rootfs must be specified.
rootfs_propagation | string RootfsPropagation is the rootfs propagation mode for the container. If not set, the default of rslave will be used. Optional.
sdnotifyMode | string Determine how to handle the NOTIFY_SOCKET - do we participate or pass it through "container" - let the OCI runtime deal with it, advertise conmon's MAINPID "conmon-only" - advertise conmon's MAINPID, send READY when started, don't pass to OCI "ignore" - unset NOTIFY_SOCKET
seccomp_policy | string SeccompPolicy determines which seccomp profile gets applied the container. valid values: empty,default,image
seccomp_profile_path | string SeccompProfilePath is the path to a JSON file containing the container's Seccomp profile. If not specified, no Seccomp profile will be used. Optional.
selinux_opts | Array of strings SelinuxProcessLabel is the process label the container will use. If SELinux is enabled and this is not specified, a label will be automatically generated if not specified. Optional.
shm_size | integer <int64> ShmSize is the size of the tmpfs to mount in at /dev/shm, in bytes. Conflicts with ShmSize if IpcNS is not private. Optional.
static_ip | Array of integers <uint8> (An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.) Note that in this documentation, referring to an IP address as an IPv4 address or an IPv6 address is a semantic property of the address, not just the length of the byte slice: a 16-byte slice can still be an IPv4 address.
static_ipv6 | Array of integers <uint8> (An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.) Note that in this documentation, referring to an IP address as an IPv4 address or an IPv6 address is a semantic property of the address, not just the length of the byte slice: a 16-byte slice can still be an IPv4 address.
static_mac | Array of integers <uint8> (A HardwareAddr represents a physical hardware address.)
stdin | boolean Stdin is whether the container will keep its STDIN open.
stop_signal | integer <int64> (A Signal is a number describing a process signal.) It implements the os.Signal interface.
stop_timeout | integer <uint64> StopTimeout is a timeout between the container's stop signal being sent and SIGKILL being sent. If not provided, the default will be used. If 0 is used, stop signal will not be sent, and SIGKILL will be sent instead. Optional.
| object Sysctl sets kernel parameters for the container
systemd | string Systemd is whether the container will be started in systemd mode. Valid options are "true", "false", and "always". "true" enables this mode only if the binary run in the container is sbin/init or systemd. "always" unconditionally enables systemd mode. "false" unconditionally disables systemd mode. If enabled, mounts and stop signal will be modified. If set to "always" or set to "true" and conditionally triggered, conflicts with StopSignal. If not specified, "false" will be assumed. Optional.
terminal | boolean Terminal is whether the container will create a PTY. Optional.
| object IO read rate limit per cgroup per device, bytes per second
| object IO read rate limit per cgroup per device, IO per second
| object IO write rate limit per cgroup per device, bytes per second
| object IO write rate limit per cgroup per device, IO per second
timezone | string Timezone is the timezone inside the container. Local means it has the same timezone as the host machine
umask | string Umask is the umask the init process of the container will be run with.
| object CgroupConf are key-value options passed into the container runtime that are used to configure cgroup v2. Optional.
unmask | Array of strings Unmask is the path we want to unmask in the container. To override all the default paths that are masked, set unmask=ALL.
use_image_hosts | boolean UseImageHosts indicates that /etc/hosts should not be managed by Podman, and instead sourced from the image. Conflicts with HostAdd.
use_image_resolve_conf | boolean UseImageResolvConf indicates that resolv.conf should not be managed by Podman, but instead sourced from the image. Conflicts with DNSServer, DNSSearch, DNSOption.
user | string User is the user the container will be run as. Can be given as a UID or a username; if a username, it will be resolved within the container, using the container's /etc/passwd. If unset, the container will be run as root. Optional.
| object (Namespace) Namespace describes the namespace
| object (Namespace) Namespace describes the namespace
| Array of objects (NamedVolume) Volumes are named volumes that will be added to the container. These will supersede Image Volumes and VolumesFrom volumes where there are conflicts. Optional.
volumes_from | Array of strings VolumesFrom is a set of containers whose volumes will be added to this container. The name or ID of the container must be provided, and may optionally be followed by a : and then one or more comma-separated options. Valid options are 'ro', 'rw', and 'z'. Options will be used for all volumes sourced from the container.
| object Weight per cgroup per device, can override BlkioWeight
work_dir | string WorkDir is the container's working directory. If unset, the default, /, will be used. Optional.

### Responses

http://podman.io/libpod/containers/create
https://podman.io/libpod/containers/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "aliases":
  {
  - "property1":
    [
    - "string"
    ],
  - "property2":
    [
    - "string"
    ]
  },
- "annotations":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "apparmor_profile": "string",
- "cap_add":
  [
  - "string"
  ],
- "cap_drop":
  [
  - "string"
  ],
- "cgroup_parent": "string",
- "cgroupns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "cgroups_mode": "string",
- "cni_networks":
  [
  - "string"
  ],
- "command":
  [
  - "string"
  ],
- "conmon_pid_file": "string",
- "containerCreateCommand":
  [
  - "string"
  ],
- "devices":
  [
  - {
    - "fileMode": 0,
    - "gid": 0,
    - "major": 0,
    - "minor": 0,
    - "path": "string",
    - "type": "string",
    - "uid": 0
    }
  ],
- "dns_option":
  [
  - "string"
  ],
- "dns_search":
  [
  - "string"
  ],
- "dns_server":
  [
  - [
    - 0
    ]
  ],
- "entrypoint":
  [
  - "string"
  ],
- "env":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "env_host": true,
- "expose": null,
- "groups":
  [
  - "string"
  ],
- "healthconfig":
  {
  - "Interval": 0,
  - "Retries": 0,
  - "StartPeriod": 0,
  - "Test":
    [
    - "string"
    ],
  - "Timeout": 0
  },
- "hostadd":
  [
  - "string"
  ],
- "hostname": "string",
- "httpproxy": true,
- "idmappings":
  {
  - "AutoUserNs": true,
  - "AutoUserNsOpts":
    {
    - "AdditionalGIDMappings":
      [
      - {
        - "container_id": 0,
        - "host_id": 0,
        - "size": 0
        }
      ],
    - "AdditionalUIDMappings":
      [
      - {
        - "container_id": 0,
        - "host_id": 0,
        - "size": 0
        }
      ],
    - "GroupFile": "string",
    - "InitialSize": 0,
    - "PasswdFile": "string",
    - "Size": 0
    },
  - "GIDMap":
    [
    - {
      - "container_id": 0,
      - "host_id": 0,
      - "size": 0
      }
    ],
  - "HostGIDMapping": true,
  - "HostUIDMapping": true,
  - "UIDMap":
    [
    - {
      - "container_id": 0,
      - "host_id": 0,
      - "size": 0
      }
    ]
  },
- "image": "string",
- "image_volume_mode": "string",
- "image_volumes":
  [
  - {
    - "Destination": "string",
    - "ReadWrite": true,
    - "Source": "string"
    }
  ],
- "init": true,
- "init_path": "string",
- "ipcns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "log_configuration":
  {
  - "driver": "string",
  - "options":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "path": "string",
  - "size": 0
  },
- "mask":
  [
  - "string"
  ],
- "mounts":
  [
  - {
    - "destination": "string",
    - "options":
      [
      - "string"
      ],
    - "source": "string",
    - "type": "string"
    }
  ],
- "name": "string",
- "namespace": "string",
- "netns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "network_options":
  {
  - "property1":
    [
    - "string"
    ],
  - "property2":
    [
    - "string"
    ]
  },
- "no_new_privileges": true,
- "oci_runtime": "string",
- "oom_score_adj": 0,
- "overlay_volumes":
  [
  - {
    - "destination": "string",
    - "source": "string"
    }
  ],
- "pidns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "pod": "string",
- "portmappings":
  [
  - {
    - "container_port": 0,
    - "host_ip": "string",
    - "host_port": 0,
    - "protocol": "string",
    - "range": 0
    }
  ],
- "privileged": true,
- "procfs_opts":
  [
  - "string"
  ],
- "publish_image_ports": true,
- "r_limits":
  [
  - {
    - "hard": 0,
    - "soft": 0,
    - "type": "string"
    }
  ],
- "raw_image_name": "string",
- "read_only_filesystem": true,
- "remove": true,
- "resource_limits":
  {
  - "blockIO":
    {
    - "leafWeight": 0,
    - "throttleReadBpsDevice":
      [
      - {
        - "major": 0,
        - "minor": 0,
        - "rate": 0
        }
      ],
    - "throttleReadIOPSDevice":
      [
      - {
        - "major": 0,
        - "minor": 0,
        - "rate": 0
        }
      ],
    - "throttleWriteBpsDevice":
      [
      - {
        - "major": 0,
        - "minor": 0,
        - "rate": 0
        }
      ],
    - "throttleWriteIOPSDevice":
      [
      - {
        - "major": 0,
        - "minor": 0,
        - "rate": 0
        }
      ],
    - "weight": 0,
    - "weightDevice":
      [
      - {
        - "leafWeight": 0,
        - "major": 0,
        - "minor": 0,
        - "weight": 0
        }
      ]
    },
  - "cpu":
    {
    - "cpus": "string",
    - "mems": "string",
    - "period": 0,
    - "quota": 0,
    - "realtimePeriod": 0,
    - "realtimeRuntime": 0,
    - "shares": 0
    },
  - "devices":
    [
    - {
      - "access": "string",
      - "allow": true,
      - "major": 0,
      - "minor": 0,
      - "type": "string"
      }
    ],
  - "hugepageLimits":
    [
    - {
      - "limit": 0,
      - "pageSize": "string"
      }
    ],
  - "memory":
    {
    - "disableOOMKiller": true,
    - "kernel": 0,
    - "kernelTCP": 0,
    - "limit": 0,
    - "reservation": 0,
    - "swap": 0,
    - "swappiness": 0,
    - "useHierarchy": true
    },
  - "network":
    {
    - "classID": 0,
    - "priorities":
      [
      - {
        - "name": "string",
        - "priority": 0
        }
      ]
    },
  - "pids":
    {
    - "limit": 0
    },
  - "rdma":
    {
    - "property1":
      {
      - "hcaHandles": 0,
      - "hcaObjects": 0
      },
    - "property2":
      {
      - "hcaHandles": 0,
      - "hcaObjects": 0
      }
    },
  - "unified":
    {
    - "property1": "string",
    - "property2": "string"
    }
  },
- "restart_policy": "string",
- "restart_tries": 0,
- "rootfs": "string",
- "rootfs_propagation": "string",
- "sdnotifyMode": "string",
- "seccomp_policy": "string",
- "seccomp_profile_path": "string",
- "selinux_opts":
  [
  - "string"
  ],
- "shm_size": 0,
- "static_ip":
  [
  - 0
  ],
- "static_ipv6":
  [
  - 0
  ],
- "static_mac":
  [
  - 0
  ],
- "stdin": true,
- "stop_signal": 0,
- "stop_timeout": 0,
- "sysctl":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "systemd": "string",
- "terminal": true,
- "throttleReadBpsDevice":
  {
  - "property1":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    },
  - "property2":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    }
  },
- "throttleReadIOPSDevice":
  {
  - "property1":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    },
  - "property2":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    }
  },
- "throttleWriteBpsDevice":
  {
  - "property1":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    },
  - "property2":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    }
  },
- "throttleWriteIOPSDevice":
  {
  - "property1":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    },
  - "property2":
    {
    - "major": 0,
    - "minor": 0,
    - "rate": 0
    }
  },
- "timezone": "string",
- "umask": "string",
- "unified":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "unmask":
  [
  - "string"
  ],
- "use_image_hosts": true,
- "use_image_resolve_conf": true,
- "user": "string",
- "userns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "utsns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "volumes":
  [
  - {
    - "Dest": "string",
    - "Name": "string",
    - "Options":
      [
      - "string"
      ]
    }
  ],
- "volumes_from":
  [
  - "string"
  ],
- "weightDevice":
  {
  - "property1":
    {
    - "leafWeight": 0,
    - "major": 0,
    - "minor": 0,
    - "weight": 0
    },
  - "property2":
    {
    - "leafWeight": 0,
    - "major": 0,
    - "minor": 0,
    - "weight": 0
    }
  },
- "work_dir": "string"

}`

### Response samples

- 201
- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Id": "string",
- "Warnings":
  [
  - "string"
  ]

}`

## List containers

Returns a list of containers

##### query Parameters

all | boolean Default: false Return all containers. By default, only running containers are shown
limit | integer Return this number of most recently created containers, including non-running ones.
pod | boolean Default: false Ignored. Previously included details on pod name and ID that are currently included by default.
size | boolean Default: false Return the size of container as fields SizeRw and SizeRootFs.
sync | boolean Default: false Sync container state with OCI runtime
filters | string A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) `before`=(`<container id>` or `<container name>`) `expose`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) `exited=<int>` containers with exit code of `<int>` `health`=(`starting`, `healthy`, `unhealthy` or `none`) `id=<ID>` a container's ID `is-task`=(`true` or `false`) `label`=(`key` or `"key=value"`) of an container label `name=<name>` a container's name `network`=(`<network id>` or `<network name>`) `pod`=(`<pod id>` or `<pod name>`) `publish`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) `since`=(`<container id>` or `<container name>`) `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`) `volume`=(`<volume name>` or `<mount point destination>`)

### Responses

http://podman.io/libpod/containers/json
https://podman.io/libpod/containers/json

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "AutoRemove": true,
  - "Command":
    [
    - "string"
    ],
  - "Created": "2019-08-24T14:15:22Z",
  - "CreatedAt": "string",
  - "ExitCode": 0,
  - "Exited": true,
  - "ExitedAt": 0,
  - "Id": "string",
  - "Image": "string",
  - "ImageID": "string",
  - "IsInfra": true,
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Mounts":
    [
    - "string"
    ],
  - "Names":
    [
    - "string"
    ],
  - "Namespaces":
    {
    - "Cgroup": "string",
    - "Ipc": "string",
    - "Mnt": "string",
    - "Net": "string",
    - "Pidns": "string",
    - "User": "string",
    - "Uts": "string"
    },
  - "Networks":
    [
    - "string"
    ],
  - "Pid": 0,
  - "Pod": "string",
  - "PodName": "string",
  - "Ports":
    [
    - {
      - "container_port": 0,
      - "host_ip": "string",
      - "host_port": 0,
      - "protocol": "string",
      - "range": 0
      }
    ],
  - "Size":
    {
    - "rootFsSize": 0,
    - "rwSize": 0
    },
  - "StartedAt": 0,
  - "State": "string",
  - "Status": "string"
  }

]`

## Delete stopped containers

Remove containers not in use

##### query Parameters

filters | string Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels.

### Responses

http://podman.io/libpod/containers/prune
https://podman.io/libpod/containers/prune

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "error": "string",
  - "id": "string",
  - "space": 0
  }

]`

## Show mounted containers

Lists all mounted containers mount points

### Responses

http://podman.io/libpod/containers/showmounted
https://podman.io/libpod/containers/showmounted

### Response samples

- 200
- 500

Content type
application/json
`
{

- "property1": "string",
- "property2": "string"

}`

## Get stats for one or more containers

Return a live stream of resource usage statistics of one or more container. If no container is specified, the statistics of all containers are returned.

##### query Parameters

containers | Array of strings names or IDs of containers
stream | boolean Default: true Stream the output

### Responses

http://podman.io/libpod/containers/stats
https://podman.io/libpod/containers/stats

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Generate Systemd Units

Generate Systemd Units based on a pod or container.

##### path Parameters

name:.* required | string Name or ID of the container or pod.

##### query Parameters

useName | boolean Default: false Use container/pod names instead of IDs.
new | boolean Default: false Create a new container instead of starting an existing one.
time | integer Default: 10 Stop timeout override.
restartPolicy | string Default: "on-failure" Enum: "no" "on-success" "on-failure" "on-abnormal" "on-watchdog" "on-abort" "always" Systemd restart-policy.
containerPrefix | string Default: "container" Systemd unit name prefix for containers.
podPrefix | string Default: "pod" Systemd unit name prefix for pods.
separator | string Default: "-" Systemd unit name separator between name/id and prefix.

### Responses

http://podman.io/libpod/generate/{name:.*}/systemd
https://podman.io/libpod/generate/{name:.*}/systemd

### Response samples

- 200
- 500

Content type
application/json
`
{

- "property1": "string",
- "property2": "string"

}`

## Generate a Kubernetes YAML file.

Generate Kubernetes YAML based on a pod or container.

##### query Parameters

names required | Array of strings Name or ID of the container or pod.
service | boolean Default: false Generate YAML for a Kubernetes service object.

### Responses

http://podman.io/libpod/generate/kube
https://podman.io/libpod/generate/kube

### Response samples

- 200
- 500

Content type
application/json
`"string"`

## Play a Kubernetes YAML file.

Create and run pods based on a Kubernetes YAML file (pod or service kind).

##### query Parameters

network | string Connect the pod to this network.
tlsVerify | boolean Default: true Require HTTPS and verify signatures when contacting registries.
logDriver | string Logging driver for the containers in the pod.
start | boolean Default: true Start the pod after creating it.

##### Request Body schema:
application/json
application/json
application/x-tar

Kubernetes YAML file.

string

### Responses

http://podman.io/libpod/play/kube
https://podman.io/libpod/play/kube

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`"string"`

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Pods":
  [
  - {
    - "ContainerErrors":
      [
      - "string"
      ],
    - "Containers":
      [
      - "string"
      ],
    - "ID": "string",
    - "Logs":
      [
      - "string"
      ]
    }
  ]

}`

# exec

Actions related to exec

## Create an exec instance

Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

##### path Parameters

name required | string name of container

##### Request Body schema:
application/json
application/json
application/x-tar

Attributes for create

AttachStderr | boolean Attach to stderr of the exec command
AttachStdin | boolean Attach to stdin of the exec command
AttachStdout | boolean Attach to stdout of the exec command
Cmd | Array of strings Command to run, as a string or array of strings.
DetachKeys | string "Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _."
Env | Array of strings A list of environment variables in the form ["VAR=value", ...]
Privileged | boolean Default: false Runs the exec process with extended privileges
Tty | boolean Allocate a pseudo-TTY
User | string "The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid."
WorkingDir | string The working directory for the exec process inside the container.

### Responses

http://podman.io/libpod/containers/{name}/exec
https://podman.io/libpod/containers/{name}/exec

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "AttachStderr": true,
- "AttachStdin": true,
- "AttachStdout": true,
- "Cmd":
  [
  - "string"
  ],
- "DetachKeys": "string",
- "Env":
  [
  - "string"
  ],
- "Privileged": false,
- "Tty": true,
- "User": "string",
- "WorkingDir": "string"

}`

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect an exec instance

Return low-level information about an exec instance.

##### path Parameters

id required | string Exec instance ID

### Responses

http://podman.io/libpod/exec/{id}/json
https://podman.io/libpod/exec/{id}/json

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Resize an exec instance

Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

##### path Parameters

id required | string Exec instance ID

##### query Parameters

h | integer Height of the TTY session in characters
w | integer Width of the TTY session in characters

### Responses

http://podman.io/libpod/exec/{id}/resize
https://podman.io/libpod/exec/{id}/resize

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Start an exec instance

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

##### path Parameters

id required | string Exec instance ID

##### Request Body schema:
application/json
application/json
application/x-tar

Attributes for start

Detach | boolean Detach from the command. Not presently supported.
Tty | boolean Allocate a pseudo-TTY. Presently ignored.

### Responses

http://podman.io/libpod/exec/{id}/start
https://podman.io/libpod/exec/{id}/start

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Detach": true,
- "Tty": true

}`

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

# images

Actions related to images

## Create image

Build an image from the given Dockerfile(s)

##### query Parameters

dockerfile | string Default: "Dockerfile" Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points to an external `Dockerfile`.
t | string Default: "latest" A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default latest value is assumed. You can provide several t parameters.
extrahosts | string TBD Extra hosts to add to /etc/hosts (As of version 1.xx)
remote | string A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball. (As of version 1.xx)
q | boolean Default: false Suppress verbose build output
nocache | boolean Default: false Do not use the cache when building the image (As of version 1.xx)
cachefrom | string JSON array of images used to build cache resolution (As of version 1.xx)
pull | boolean Default: false Attempt to pull the image even if an older image exists locally (As of version 1.xx)
rm | boolean Default: true Remove intermediate containers after a successful build (As of version 1.xx)
forcerm | boolean Default: false Always remove intermediate containers, even upon failure (As of version 1.xx)
memory | integer Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx)
memswap | integer MemorySwap limits the amount of memory and swap together (As of version 1.xx)
cpushares | integer CPUShares (relative weight (As of version 1.xx)
cpusetcpus | string CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx)
cpuperiod | integer CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx)
cpuquota | integer CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx)
buildargs | string JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `["Foo":"bar"]`. For example, buildargs={"Foo":"bar"}. Note(s): This should not be used to pass secrets. The value of buildargs should be URI component encoded before being passed to the API. (As of version 1.xx)
shmsize | integer Default: 67108864 ShmSize is the "size" value to use when mounting an shmfs on the container's /dev/shm directory. Default is 64MB (As of version 1.xx)
squash | boolean Default: false Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx)
labels | string JSON map of key, value pairs to set as labels on the new image (As of version 1.xx)
networkmode | string Default: "bridge" Sets the networking mode for the run commands during build. Supported standard values are: `bridge` limited to containers within a single host, port mapping required for external access `host` no isolation between host and containers on this network `none` disable all networking for this container container: share networking with given container --All other values are assumed to be a custom network's name (As of version 1.xx)
platform | string Platform format os[/arch[/variant]] (As of version 1.xx)
target | string Target build stage (As of version 1.xx)
outputs | string output configuration TBD (As of version 1.xx)
httpproxy | boolean Inject http proxy environment variables into container (As of version 2.0.0)

### Responses

http://podman.io/libpod/build
https://podman.io/libpod/build

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "stream": "(build details...)\nSuccessfully built 8ba084515c724cbf90d447a63600c0a6\n"

}`

## Remove an image from the local storage.

Remove an image from the local storage.

##### path Parameters

name:.* required | string name or ID of image to remove

##### query Parameters

force | boolean remove the image even if used by containers or has other tags

### Responses

http://podman.io/libpod/images/{name:.*}
https://podman.io/libpod/images/{name:.*}

### Response samples

- 200
- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "deleted": "string",
  - "untagged":
    [
    - "string"
    ]
  }

]`

## Image exists

Check if image exists in local store

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/libpod/images/{name:.*}/exists
https://podman.io/libpod/images/{name:.*}/exists

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Export an image

Export an image

##### path Parameters

name:.* required | string the name or ID of the container

##### query Parameters

format | string format for exported image
compress | boolean use compression on image

### Responses

http://podman.io/libpod/images/{name:.*}/get
https://podman.io/libpod/images/{name:.*}/get

### Response samples

- 200
- 404
- 500

Content type
application/json
`"string"`

## History of an image

Return parent layers of an image.

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/libpod/images/{name:.*}/history
https://podman.io/libpod/images/{name:.*}/history

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Comment": "string",
- "Created": 0,
- "CreatedBy": "string",
- "Id": "string",
- "Size": 0,
- "Tags":
  [
  - "string"
  ]

}`

## Inspect an image

Obtain low-level information about an image

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/libpod/images/{name:.*}/json
https://podman.io/libpod/images/{name:.*}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Annotations":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Architecture": "string",
- "Author": "string",
- "Comment": "string",
- "Config":
  {
  - "Cmd":
    [
    - "string"
    ],
  - "Entrypoint":
    [
    - "string"
    ],
  - "Env":
    [
    - "string"
    ],
  - "ExposedPorts":
    {
    - "property1": { },
    - "property2": { }
    },
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "StopSignal": "string",
  - "User": "string",
  - "Volumes":
    {
    - "property1": { },
    - "property2": { }
    },
  - "WorkingDir": "string"
  },
- "Created": "2019-08-24T14:15:22Z",
- "Digest": "string",
- "GraphDriver":
  {
  - "Data":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string"
  },
- "Healthcheck":
  {
  - "Interval": 0,
  - "Retries": 0,
  - "StartPeriod": 0,
  - "Test":
    [
    - "string"
    ],
  - "Timeout": 0
  },
- "History":
  [
  - {
    - "author": "string",
    - "comment": "string",
    - "created": "2019-08-24T14:15:22Z",
    - "created_by": "string",
    - "empty_layer": true
    }
  ],
- "Id": "string",
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "ManifestType": "string",
- "NamesHistory":
  [
  - "string"
  ],
- "Os": "string",
- "Parent": "string",
- "RepoDigests":
  [
  - "string"
  ],
- "RepoTags":
  [
  - "string"
  ],
- "RootFS":
  {
  - "Layers":
    [
    - "string"
    ],
  - "Type": "string"
  },
- "Size": 0,
- "User": "string",
- "Version": "string",
- "VirtualSize": 0

}`

## Push Image

Push an image to a container registry

##### path Parameters

name:.* required | string Name of image to push.

##### query Parameters

destination | string Allows for pushing the image to a different destination than the image refers to.
tlsVerify | boolean Default: true Require TLS verification.

##### header Parameters

X-Registry-Auth | string A base64-encoded auth configuration.

### Responses

http://podman.io/libpod/images/{name:.*}/push
https://podman.io/libpod/images/{name:.*}/push

### Response samples

- 200
- 404
- 500

Content type
application/json
`"string"`

## Tag an image

Tag an image so that it becomes part of a repository.

##### path Parameters

name:.* required | string the name or ID of the container

##### query Parameters

repo | string the repository to tag in
tag | string the name of the new tag

### Responses

http://podman.io/libpod/images/{name:.*}/tag
https://podman.io/libpod/images/{name:.*}/tag

### Response samples

- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Image tree

Retrieve the image tree for the provided image name or ID

##### path Parameters

name:.* required | string the name or ID of the container

##### query Parameters

whatrequires | boolean show all child images and layers of the specified image

### Responses

http://podman.io/libpod/images/{name:.*}/tree
https://podman.io/libpod/images/{name:.*}/tree

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "id": "string",
- "layers":
  [
  - { }
  ],
- "size": "string",
- "tags":
  [
  - "string"
  ]

}`

## Untag an image

Untag an image. If not repo and tag are specified, all tags are removed from the image.

##### path Parameters

name:.* required | string the name or ID of the container

##### query Parameters

repo | string the repository to untag
tag | string the name of the tag to untag

### Responses

http://podman.io/libpod/images/{name:.*}/untag
https://podman.io/libpod/images/{name:.*}/untag

### Response samples

- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Report on changes to images's filesystem; adds, deletes or modifications.

Returns which files in a images's filesystem have been added, deleted, or modified. The Kind of modification can be one of:

0: Modified 1: Added 2: Deleted

##### path Parameters

name required | string the name or id of the container

### Responses

http://podman.io/libpod/images/{name}/changes
https://podman.io/libpod/images/{name}/changes

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Export multiple images

Export multiple images into a single object. Only `docker-archive` is currently supported.

##### query Parameters

format | string format for exported image (only docker-archive is supported)
references | Array of strings references to images to export
compress | boolean use compression on image

### Responses

http://podman.io/libpod/images/export
https://podman.io/libpod/images/export

### Response samples

- 200
- 404
- 500

Content type
application/json
`"string"`

## Import image

Import a previously exported tarball as an image.

##### query Parameters

changes | Array of strings Apply the following possible instructions to the created image: CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string
message | string Set commit message for imported image
reference | string Optional Name[:TAG] for the image
url | string Load image from the specified URL

##### Request Body schema: application/x-www-form-urlencoded

upload required | string <binary> tarball for imported image

### Responses

http://podman.io/libpod/images/import
https://podman.io/libpod/images/import

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Id": "string"

}`

## List Images

Returns a list of images on the server

##### query Parameters

all | boolean Default: false Show all images. Only images from a final layer (no children) are shown by default.
filters | string A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) `dangling=true` `label=key` or `label="key=value"` of an image label `reference`=(`<image-name>[:<tag>]`) `id`=(`<image-id>`) `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)

### Responses

http://podman.io/libpod/images/json
https://podman.io/libpod/images/json

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "Containers": 0,
  - "Created": 0,
  - "Id": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "ParentId": "string",
  - "RepoDigests":
    [
    - "string"
    ],
  - "RepoTags":
    [
    - "string"
    ],
  - "SharedSize": 0,
  - "Size": 0,
  - "VirtualSize": 0
  }

]`

## Load image

Load an image (oci-archive or docker-archive) stream.

##### Request Body schema: application/x-www-form-urlencoded

upload required | string <binary> tarball of container image

### Responses

http://podman.io/libpod/images/load
https://podman.io/libpod/images/load

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Names":
  [
  - "string"
  ]

}`

## Prune unused images

Remove images that are not being used by a container

##### query Parameters

filters | string filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters: `dangling=<boolean>` When set to `true` (or `1`), prune only unused and untagged images. When set to `false` (or `0`), all unused images are pruned. `until=<string>` Prune images created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is used) the specified labels.

### Responses

http://podman.io/libpod/images/prune
https://podman.io/libpod/images/prune

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "deleted": "string",
  - "untagged":
    [
    - "string"
    ]
  }

]`

## Pull images

Pull one or more images from a container registry.

##### query Parameters

reference | string Mandatory reference to the image (e.g., quay.io/image/name:tag)
credentials | string username:password for the registry
overrideArch | string Pull image for the specified architecture.
overrideOS | string Pull image for the specified operating system.
overrideVariant | string Pull image for the specified variant.
tlsVerify | boolean Default: true Require TLS verification.
allTags | boolean Pull all tagged images in the repository.

### Responses

http://podman.io/libpod/images/pull
https://podman.io/libpod/images/pull

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "error": "string",
- "id": "string",
- "images":
  [
  - "string"
  ],
- "stream": "string"

}`

## Remove one or more images from the storage.

Remove one or more images from the storage.

##### query Parameters

images | Array of strings Images IDs or names to remove.
all | boolean Default: true Remove all images.
force | boolean Force image removal (including containers using the images).

### Responses

http://podman.io/libpod/images/remove
https://podman.io/libpod/images/remove

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Deleted":
  [
  - "string"
  ],
- "Errors":
  [
  - "string"
  ],
- "ExitCode": 0,
- "Untagged":
  [
  - "string"
  ]

}`

## Search images

Search registries for images

##### query Parameters

term | string term to search
limit | integer maximum number of results
noTrunc | boolean do not truncate any of the result strings
filters | string A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: `is-automated=(true|false)` `is-official=(true|false)` `stars=<number>` Matches images that has at least 'number' stars.

### Responses

http://podman.io/libpod/images/search
https://podman.io/libpod/images/search

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Automated": "string",
- "Description": "string",
- "Index": "string",
- "Name": "string",
- "Official": "string",
- "Stars": 0,
- "Tag": "string"

}`

# manifests

Actions related to manifests

## Remove

Remove an image from a manifest list

##### path Parameters

name:.* required | string the image associated with the manifest

##### query Parameters

digest | string image digest to be removed

### Responses

http://podman.io/libpod/manifests/{name:.*}
https://podman.io/libpod/manifests/{name:.*}

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## AddManifest

Add an image to a manifest list

##### path Parameters

name:.* required | string the name or ID of the manifest

##### Request Body schema:
application/json
application/json
application/x-tar

options for creating a manifest

all | boolean
| object
arch | string
features | Array of strings
images | Array of strings
os | string
os_version | string
variant | string

### Responses

http://podman.io/libpod/manifests/{name:.*}/add
https://podman.io/libpod/manifests/{name:.*}/add

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "all": true,
- "annotation":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "arch": "string",
- "features":
  [
  - "string"
  ],
- "images":
  [
  - "string"
  ],
- "os": "string",
- "os_version": "string",
- "variant": "string"

}`

### Response samples

- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect

Display a manifest list

##### path Parameters

name:.* required | string the name or ID of the manifest

### Responses

http://podman.io/libpod/manifests/{name:.*}/json
https://podman.io/libpod/manifests/{name:.*}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Clone": { },
- "Instances":
  [
  - "string"
  ],
- "MIMEType": "string"

}`

## Push

Push a manifest list or image index to a registry

##### path Parameters

name required | string the name or ID of the manifest

##### query Parameters

destination required | string the destination for the manifest
all | boolean push all images

### Responses

http://podman.io/libpod/manifests/{name}/push
https://podman.io/libpod/manifests/{name}/push

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Create

Create a manifest list

##### query Parameters

name required | string manifest list name
image | string name of the image
all | boolean add all contents if given list

### Responses

http://podman.io/libpod/manifests/create
https://podman.io/libpod/manifests/create

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

# networks

Actions related to networks

## Remove a network

Remove a CNI configured network

##### path Parameters

name required | string the name of the network

##### query Parameters

force | boolean remove containers associated with network

### Responses

http://podman.io/libpod/networks/{name}
https://podman.io/libpod/networks/{name}

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Err": "string",
- "Name": "string"

}`

## Connect container to network

Connect a container to a network.

##### path Parameters

name required | string the name of the network

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for connecting a container to a network

| object in:body

### Responses

http://podman.io/libpod/networks/{name}/connect
https://podman.io/libpod/networks/{name}/connect

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Body":
  {
  - "Container": "string",
  - "EndpointConfig":
    {
    - "Aliases":
      [
      - "string"
      ],
    - "DriverOpts":
      {
      - "property1": "string",
      - "property2": "string"
      },
    - "EndpointID": "string",
    - "Gateway": "string",
    - "GlobalIPv6Address": "string",
    - "GlobalIPv6PrefixLen": 0,
    - "IPAMConfig":
      {
      - "IPv4Address": "string",
      - "IPv6Address": "string",
      - "LinkLocalIPs":
        [
        - "string"
        ]
      },
    - "IPAddress": "string",
    - "IPPrefixLen": 0,
    - "IPv6Gateway": "string",
    - "Links":
      [
      - "string"
      ],
    - "MacAddress": "string",
    - "NetworkID": "string"
    }
  }

}`

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Disconnect container from network

Disconnect a container from a network.

##### path Parameters

name required | string the name of the network

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for disconnecting a container from a network

| object in:body

### Responses

http://podman.io/libpod/networks/{name}/disconnect
https://podman.io/libpod/networks/{name}/disconnect

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Body":
  {
  - "Container": "string",
  - "Force": true
  }

}`

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect a network

Display low level configuration for a CNI network

##### path Parameters

name required | string the name of the network

### Responses

http://podman.io/libpod/networks/{name}/json
https://podman.io/libpod/networks/{name}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "property1": { },
  - "property2": { }
  }

]`

## Create network

Create a new CNI network configuration

##### query Parameters

name | string optional name for new network

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for creating a container

DisableDNS | boolean
Driver | string
Gateway | Array of integers <uint8> (An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.) Note that in this documentation, referring to an IP address as an IPv4 address or an IPv6 address is a semantic property of the address, not just the length of the byte slice: a 16-byte slice can still be an IPv4 address.
IPv6 | boolean
Internal | boolean
| object
MacVLAN | string
| object Mapping of driver options and values.
| object (An IPNet represents an IP network.)
| object (An IPNet represents an IP network.)

### Responses

http://podman.io/libpod/networks/create
https://podman.io/libpod/networks/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "DisableDNS": true,
- "Driver": "string",
- "Gateway":
  [
  - 0
  ],
- "IPv6": true,
- "Internal": true,
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "MacVLAN": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Range":
  {
  - "IP":
    [
    - 0
    ],
  - "Mask":
    [
    - 0
    ]
  },
- "Subnet":
  {
  - "IP":
    [
    - 0
    ],
  - "Mask":
    [
    - 0
    ]
  }

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Filename": "string"

}`

## List networks

Display summary of network configurations

##### query Parameters

filters | string JSON encoded value of the filters (a map[string][]string) to process on the network list. Available filters: name=[name] Matches network name (accepts regex). id=[id] Matches for full or partial ID. driver=[driver] Only bridge is supported. label=[key] or label=[key=value] Matches networks based on the presence of a label alone or a label and a value. plugin=[plugin] Matches CNI plugins included in a network (e.g `bridge`,`portmap`,`firewall`,`tuning`,`dnsname`,`macvlan`)

### Responses

http://podman.io/libpod/networks/json
https://podman.io/libpod/networks/json

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "Bytes":
    [
    - 0
    ],
  - "CNIVersion": "string",
  - "DisableCheck": true,
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string",
  - "Plugins":
    [
    - {
      - "Bytes":
        [
        - 0
        ],
      - "Network":
        {
        - "capabilities":
          {
          - "property1": true,
          - "property2": true
          },
        - "cniVersion": "string",
        - "dns":
          {
          - "domain": "string",
          - "nameservers":
            [
            - "string"
            ],
          - "options":
            [
            - "string"
            ],
          - "search":
            [
            - "string"
            ]
          },
        - "ipam":
          {
          - "Config":
            [
            - {
              - "AuxiliaryAddresses":
                {
                - "property1": "string",
                - "property2": "string"
                },
              - "Gateway": "string",
              - "IPRange": "string",
              - "Subnet": "string"
              }
            ],
          - "Driver": "string",
          - "Options":
            {
            - "property1": "string",
            - "property2": "string"
            }
          },
        - "name": "string",
        - "prevResult":
          {
          - "property1": { },
          - "property2": { }
          },
        - "type": "string"
        }
      }
    ]
  }

]`

# pods

Actions related to pods

## Generate Systemd Units

Generate Systemd Units based on a pod or container.

##### path Parameters

name:.* required | string Name or ID of the container or pod.

##### query Parameters

useName | boolean Default: false Use container/pod names instead of IDs.
new | boolean Default: false Create a new container instead of starting an existing one.
time | integer Default: 10 Stop timeout override.
restartPolicy | string Default: "on-failure" Enum: "no" "on-success" "on-failure" "on-abnormal" "on-watchdog" "on-abort" "always" Systemd restart-policy.
containerPrefix | string Default: "container" Systemd unit name prefix for containers.
podPrefix | string Default: "pod" Systemd unit name prefix for pods.
separator | string Default: "-" Systemd unit name separator between name/id and prefix.

### Responses

http://podman.io/libpod/generate/{name:.*}/systemd
https://podman.io/libpod/generate/{name:.*}/systemd

### Response samples

- 200
- 500

Content type
application/json
`
{

- "property1": "string",
- "property2": "string"

}`

## Generate a Kubernetes YAML file.

Generate Kubernetes YAML based on a pod or container.

##### query Parameters

names required | Array of strings Name or ID of the container or pod.
service | boolean Default: false Generate YAML for a Kubernetes service object.

### Responses

http://podman.io/libpod/generate/kube
https://podman.io/libpod/generate/kube

### Response samples

- 200
- 500

Content type
application/json
`"string"`

## Play a Kubernetes YAML file.

Create and run pods based on a Kubernetes YAML file (pod or service kind).

##### query Parameters

network | string Connect the pod to this network.
tlsVerify | boolean Default: true Require HTTPS and verify signatures when contacting registries.
logDriver | string Logging driver for the containers in the pod.
start | boolean Default: true Start the pod after creating it.

##### Request Body schema:
application/json
application/json
application/x-tar

Kubernetes YAML file.

string

### Responses

http://podman.io/libpod/play/kube
https://podman.io/libpod/play/kube

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`"string"`

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Pods":
  [
  - {
    - "ContainerErrors":
      [
      - "string"
      ],
    - "Containers":
      [
      - "string"
      ],
    - "ID": "string",
    - "Logs":
      [
      - "string"
      ]
    }
  ]

}`

## Remove pod

##### path Parameters

name required | string the name or ID of the pod

##### query Parameters

force | boolean force removal of a running pod by first stopping all containers, then removing all containers in the pod

### Responses

http://podman.io/libpod/pods/{name}
https://podman.io/libpod/pods/{name}

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Err": "string",
- "Id": "string"

}`

## Pod exists

Check if a pod exists by name or ID

##### path Parameters

name required | string the name or ID of the pod

### Responses

http://podman.io/libpod/pods/{name}/exists
https://podman.io/libpod/pods/{name}/exists

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect pod

##### path Parameters

name required | string the name or ID of the pod

### Responses

http://podman.io/libpod/pods/{name}/json
https://podman.io/libpod/pods/{name}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "CgroupParent": "string",
- "CgroupPath": "string",
- "Containers":
  [
  - {
    - "Id": "string",
    - "Name": "string",
    - "State": "string"
    }
  ],
- "CreateCgroup": true,
- "CreateCommand":
  [
  - "string"
  ],
- "CreateInfra": true,
- "Created": "2019-08-24T14:15:22Z",
- "Hostname": "string",
- "Id": "string",
- "InfraConfig":
  {
  - "DNSOption":
    [
    - "string"
    ],
  - "DNSSearch":
    [
    - "string"
    ],
  - "DNSServer":
    [
    - "string"
    ],
  - "HostAdd":
    [
    - "string"
    ],
  - "HostNetwork": true,
  - "NetworkOptions":
    {
    - "property1":
      [
      - "string"
      ],
    - "property2":
      [
      - "string"
      ]
    },
  - "Networks":
    [
    - "string"
    ],
  - "NoManageHosts": true,
  - "NoManageResolvConf": true,
  - "PortBindings":
    {
    - "property1":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ],
    - "property2":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ]
    },
  - "StaticIP":
    [
    - 0
    ],
  - "StaticMAC": "string"
  },
- "InfraContainerID": "string",
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Name": "string",
- "Namespace": "string",
- "NumContainers": 0,
- "SharedNamespaces":
  [
  - "string"
  ],
- "State": "string"

}`

## Kill a pod

##### path Parameters

name required | string the name or ID of the pod

##### query Parameters

signal | string Default: "SIGKILL" signal to be sent to pod

### Responses

http://podman.io/libpod/pods/{name}/kill
https://podman.io/libpod/pods/{name}/kill

### Response samples

- 200
- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Errs":
  [
  - "string"
  ],
- "Id": "string"

}`

## Pause a pod

Pause a pod

##### path Parameters

name required | string the name or ID of the pod

### Responses

http://podman.io/libpod/pods/{name}/pause
https://podman.io/libpod/pods/{name}/pause

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Errs":
  [
  - "string"
  ],
- "Id": "string"

}`

## Restart a pod

##### path Parameters

name required | string the name or ID of the pod

### Responses

http://podman.io/libpod/pods/{name}/restart
https://podman.io/libpod/pods/{name}/restart

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Errs":
  [
  - "string"
  ],
- "Id": "string"

}`

## Start a pod

##### path Parameters

name required | string the name or ID of the pod

### Responses

http://podman.io/libpod/pods/{name}/start
https://podman.io/libpod/pods/{name}/start

### Response samples

- 200
- 304
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Errs":
  [
  - "string"
  ],
- "Id": "string"

}`

## Stop a pod

##### path Parameters

name required | string the name or ID of the pod

##### query Parameters

t | integer timeout

### Responses

http://podman.io/libpod/pods/{name}/stop
https://podman.io/libpod/pods/{name}/stop

### Response samples

- 200
- 304
- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Errs":
  [
  - "string"
  ],
- "Id": "string"

}`

## List processes

List processes running inside a pod

##### path Parameters

name required | string Name of pod to query for processes

##### query Parameters

stream | boolean Default: true Stream the output
ps_args | string Default: "-ef" arguments to pass to ps such as aux. Requires ps(1) to be installed in the container if no ps(1) compatible AIX descriptors are used.

### Responses

http://podman.io/libpod/pods/{name}/top
https://podman.io/libpod/pods/{name}/top

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Processes":
  [
  - [
    - "string"
    ]
  ],
- "Titles":
  [
  - "string"
  ]

}`

## Unpause a pod

##### path Parameters

name required | string the name or ID of the pod

### Responses

http://podman.io/libpod/pods/{name}/unpause
https://podman.io/libpod/pods/{name}/unpause

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Errs":
  [
  - "string"
  ],
- "Id": "string"

}`

## Create a pod

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for creating a pod

cgroup_parent | string CgroupParent is the parent for the CGroup that the pod will create. This pod cgroup will, in turn, be the default cgroup parent for all containers in the pod. Optional.
cni_networks | Array of strings CNINetworks is a list of CNI networks that the infra container will join. As, by default, containers share their network with the infra container, these networks will effectively be joined by the entire pod. Only available when NetNS is set to Bridge, the default for root. Optional.
dns_option | Array of strings DNSOption is a set of DNS options that will be used in the infra container's resolv.conf, which will, by default, be shared with all containers in the pod. Conflicts with NoInfra=true. Optional.
dns_search | Array of strings DNSSearch is a set of DNS search domains that will be used in the infra container's resolv.conf, which will, by default, be shared with all containers in the pod. If not provided, DNS search domains from the host's resolv.conf will be used. Conflicts with NoInfra=true. Optional.
dns_server | Array of Array of integers (An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.) DNSServer is a set of DNS servers that will be used in the infra container's resolv.conf, which will, by default, be shared with all containers in the pod. If not provided, the host's DNS servers will be used, unless the only server set is a localhost address. As the container cannot connect to the host's localhost, a default server will instead be set. Conflicts with NoInfra=true. Optional.
hostadd | Array of strings HostAdd is a set of hosts that will be added to the infra container's etc/hosts that will, by default, be shared with all containers in the pod. Conflicts with NoInfra=true and NoManageHosts. Optional.
hostname | string Hostname is the pod's hostname. If not set, the name of the pod will be used (if a name was not provided here, the name auto-generated for the pod will be used). This will be used by the infra container and all containers in the pod as long as the UTS namespace is shared. Optional.
infra_command | Array of strings InfraCommand sets the command that will be used to start the infra container. If not set, the default set in the Libpod configuration file will be used. Conflicts with NoInfra=true. Optional.
infra_conmon_pid_file | string InfraConmonPidFile is a custom path to store the infra container's conmon PID.
infra_image | string InfraImage is the image that will be used for the infra container. If not set, the default set in the Libpod configuration file will be used. Conflicts with NoInfra=true. Optional.
| object Labels are key-value pairs that are used to add metadata to pods. Optional.
name | string Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional.
| object (Namespace) Namespace describes the namespace
| object NetworkOptions are additional options for each network Optional.
no_infra | boolean NoInfra tells the pod not to create an infra container. If this is done, many networking-related options will become unavailable. Conflicts with setting any options in PodNetworkConfig, and the InfraCommand and InfraImages in this struct. Optional.
no_manage_hosts | boolean NoManageHosts indicates that /etc/hosts should not be managed by the pod. Instead, each container will create a separate /etc/hosts as they would if not in a pod. Conflicts with HostAdd.
no_manage_resolv_conf | boolean NoManageResolvConf indicates that /etc/resolv.conf should not be managed by the pod. Instead, each container will create and manage a separate resolv.conf as if they had not joined a pod. Conflicts with NoInfra=true and DNSServer, DNSSearch, DNSOption. Optional.
pod_create_command | Array of strings PodCreateCommand is the command used to create this pod. This will be shown in the output of Inspect() on the pod, and may also be used by some tools that wish to recreate the pod (e.g. `podman generate systemd --new`). Optional.
| Array of objects (PortMapping is one or more ports that will be mapped into the container.) PortMappings is a set of ports to map into the infra container. As, by default, containers share their network with the infra container, this will forward the ports to the entire pod. Only available if NetNS is set to Bridge or Slirp. Optional.
shared_namespaces | Array of strings SharedNamespaces instructs the pod to share a set of namespaces. Shared namespaces will be joined (by default) by every container which joins the pod. If not set and NoInfra is false, the pod will set a default set of namespaces to share. Conflicts with NoInfra=true. Optional.
static_ip | Array of integers <uint8> (An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.) Note that in this documentation, referring to an IP address as an IPv4 address or an IPv6 address is a semantic property of the address, not just the length of the byte slice: a 16-byte slice can still be an IPv4 address.
static_mac | Array of integers <uint8> (A HardwareAddr represents a physical hardware address.)

### Responses

http://podman.io/libpod/pods/create
https://podman.io/libpod/pods/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "cgroup_parent": "string",
- "cni_networks":
  [
  - "string"
  ],
- "dns_option":
  [
  - "string"
  ],
- "dns_search":
  [
  - "string"
  ],
- "dns_server":
  [
  - [
    - 0
    ]
  ],
- "hostadd":
  [
  - "string"
  ],
- "hostname": "string",
- "infra_command":
  [
  - "string"
  ],
- "infra_conmon_pid_file": "string",
- "infra_image": "string",
- "labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "name": "string",
- "netns":
  {
  - "nsmode": "string",
  - "string": "string"
  },
- "network_options":
  {
  - "property1":
    [
    - "string"
    ],
  - "property2":
    [
    - "string"
    ]
  },
- "no_infra": true,
- "no_manage_hosts": true,
- "no_manage_resolv_conf": true,
- "pod_create_command":
  [
  - "string"
  ],
- "portmappings":
  [
  - {
    - "container_port": 0,
    - "host_ip": "string",
    - "host_port": 0,
    - "protocol": "string",
    - "range": 0
    }
  ],
- "shared_namespaces":
  [
  - "string"
  ],
- "static_ip":
  [
  - 0
  ],
- "static_mac":
  [
  - 0
  ]

}`

### Response samples

- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## List pods

##### query Parameters

filters | string needs description and plumbing for filters

### Responses

http://podman.io/libpod/pods/json
https://podman.io/libpod/pods/json

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "Cgroup": "string",
  - "Containers":
    [
    - {
      - "Id": "string",
      - "Names": "string",
      - "Status": "string"
      }
    ],
  - "Created": "2019-08-24T14:15:22Z",
  - "Id": "string",
  - "InfraId": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string",
  - "Namespace": "string",
  - "Networks":
    [
    - "string"
    ],
  - "Status": "string"
  }

]`

## Prune unused pods

### Responses

http://podman.io/libpod/pods/prune
https://podman.io/libpod/pods/prune

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Err": "string",
- "Id": "string"

}`

## Get stats for one or more pods

Display a live stream of resource usage statistics for the containers in one or more pods

##### query Parameters

all | boolean Provide statistics for all running pods.
namesOrIDs | Array of strings Names or IDs of pods.

### Responses

http://podman.io/libpod/pods/stats
https://podman.io/libpod/pods/stats

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Processes":
  [
  - [
    - "string"
    ]
  ],
- "Titles":
  [
  - "string"
  ]

}`

# volumes

Actions related to volumes

## Remove volume

##### path Parameters

name required | string the name or ID of the volume

##### query Parameters

force | boolean force removal

### Responses

http://podman.io/libpod/volumes/{name}
https://podman.io/libpod/volumes/{name}

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect volume

##### path Parameters

name required | string the name or ID of the volume

### Responses

http://podman.io/libpod/volumes/{name}/json
https://podman.io/libpod/volumes/{name}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Anonymous": true,
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Driver": "string",
- "GID": 0,
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Mountpoint": "string",
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Scope": "string",
- "Status":
  {
  - "property1": { },
  - "property2": { }
  },
- "UID": 0

}`

## Create a volume

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for creating a container

Driver | string Volume driver to use
| object User-defined key/value metadata.
Name | string New volume's name. Can be left blank
| object Mapping of driver options and values.

### Responses

http://podman.io/libpod/volumes/create
https://podman.io/libpod/volumes/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Driver": "string",
- "Label":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  }

}`

### Response samples

- 201
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Anonymous": true,
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Driver": "string",
- "GID": 0,
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Mountpoint": "string",
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Scope": "string",
- "Status":
  {
  - "property1": { },
  - "property2": { }
  },
- "UID": 0

}`

## List volumes

Returns a list of volumes

##### query Parameters

filters | string JSON encoded value of the filters (a map[string][]string) to process on the volumes list. Available filters: driver= Matches volumes based on their driver. label= or label=: Matches volumes based on the presence of a label alone or a label and a value. name= Matches all of volume name. opt= Matches a storage driver options

### Responses

http://podman.io/libpod/volumes/json
https://podman.io/libpod/volumes/json

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "CreatedAt": "string",
  - "Driver": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Mountpoint": "string",
  - "Name": "string",
  - "Options":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Scope": "string",
  - "Status":
    {
    - "property1": { },
    - "property2": { }
    },
  - "UsageData":
    {
    - "RefCount": 0,
    - "Size": 0
    }
  }

]`

## Prune volumes

### Responses

http://podman.io/libpod/volumes/prune
https://podman.io/libpod/volumes/prune

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "Err": "string",
  - "Id": "string",
  - "Size": 0
  }

]`

# system

Actions related to Podman engine

## Ping service

Return protocol information in response headers. `HEAD /libpod/_ping` is also supported. `/_ping` is available for compatibility with other engines. The '_ping' endpoints are not versioned.

### Responses

http://podman.io/libpod/_ping
https://podman.io/libpod/_ping

### Response samples

- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get events

Returns events filtered on query parameters

##### query Parameters

since | string start streaming events from this time
until | string stop streaming events later than this
filters | string JSON encoded map[string][]string of constraints
stream | boolean Default: true when false, do not follow events

### Responses

http://podman.io/libpod/events
https://podman.io/libpod/events

### Response samples

- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get info

Returns information on the system and libpod configuration

### Responses

http://podman.io/libpod/info
https://podman.io/libpod/info

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "host":
  {
  - "arch": "string",
  - "buildahVersion": "string",
  - "cgroupManager": "string",
  - "cgroupVersion": "string",
  - "conmon":
    {
    - "package": "string",
    - "path": "string",
    - "version": "string"
    },
  - "cpus": 0,
  - "distribution":
    {
    - "distribution": "string",
    - "version": "string"
    },
  - "eventLogger": "string",
  - "hostname": "string",
  - "idMappings":
    {
    - "gidmap":
      [
      - {
        - "container_id": 0,
        - "host_id": 0,
        - "size": 0
        }
      ],
    - "uidmap":
      [
      - {
        - "container_id": 0,
        - "host_id": 0,
        - "size": 0
        }
      ]
    },
  - "kernel": "string",
  - "linkmode": "string",
  - "memFree": 0,
  - "memTotal": 0,
  - "ociRuntime":
    {
    - "name": "string",
    - "package": "string",
    - "path": "string",
    - "version": "string"
    },
  - "os": "string",
  - "remoteSocket":
    {
    - "exists": true,
    - "path": "string"
    },
  - "runtimeInfo":
    {
    - "property1": { },
    - "property2": { }
    },
  - "security":
    {
    - "apparmorEnabled": true,
    - "capabilities": "string",
    - "rootless": true,
    - "seccompEnabled": true,
    - "selinuxEnabled": true
    },
  - "slirp4netns":
    {
    - "executable": "string",
    - "package": "string",
    - "version": "string"
    },
  - "swapFree": 0,
  - "swapTotal": 0,
  - "uptime": "string"
  },
- "registries":
  {
  - "property1": { },
  - "property2": { }
  },
- "store":
  {
  - "configFile": "string",
  - "containerStore":
    {
    - "number": 0,
    - "paused": 0,
    - "running": 0,
    - "stopped": 0
    },
  - "graphDriverName": "string",
  - "graphOptions":
    {
    - "property1": { },
    - "property2": { }
    },
  - "graphRoot": "string",
  - "graphStatus":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "imageStore":
    {
    - "number": 0
    },
  - "runRoot": "string",
  - "volumePath": "string"
  },
- "version":
  {
  - "APIVersion": "string",
  - "Built": 0,
  - "BuiltTime": "string",
  - "GitCommit": "string",
  - "GoVersion": "string",
  - "OsArch": "string",
  - "Version": "string"
  }

}`

## Show disk usage

Return information about disk usage for containers, images, and volumes

### Responses

http://podman.io/libpod/system/df
https://podman.io/libpod/system/df

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Containers":
  [
  - {
    - "Command":
      [
      - "string"
      ],
    - "ContainerID": "string",
    - "Created": "2019-08-24T14:15:22Z",
    - "Image": "string",
    - "LocalVolumes": 0,
    - "Names": "string",
    - "RWSize": 0,
    - "Size": 0,
    - "Status": "string"
    }
  ],
- "Images":
  [
  - {
    - "Containers": 0,
    - "Created": "2019-08-24T14:15:22Z",
    - "ImageID": "string",
    - "Repository": "string",
    - "SharedSize": 0,
    - "Size": 0,
    - "Tag": "string",
    - "UniqueSize": 0
    }
  ],
- "Volumes":
  [
  - {
    - "Links": 0,
    - "ReclaimableSize": 0,
    - "Size": 0,
    - "VolumeName": "string"
    }
  ]

}`

## Prune unused data

### Responses

http://podman.io/libpod/system/prune
https://podman.io/libpod/system/prune

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "ContainerPruneReports":
  [
  - {
    - "Err": "string",
    - "Id": "string",
    - "Size": 0
    }
  ],
- "ImagePruneReports":
  [
  - {
    - "Err": "string",
    - "Id": "string",
    - "Size": 0
    }
  ],
- "PodPruneReport":
  [
  - {
    - "Err": "string",
    - "Id": "string"
    }
  ],
- "ReclaimedSpace": 0,
- "VolumePruneReports":
  [
  - {
    - "Err": "string",
    - "Id": "string",
    - "Size": 0
    }
  ]

}`

## Component Version information

### Responses

http://podman.io/libpod/version
https://podman.io/libpod/version

### Response samples

- 200

Content type
application/json
application/json
text/plain
text/html
`
{

- "Client":
  {
  - "APIVersion": "string",
  - "Built": 0,
  - "BuiltTime": "string",
  - "GitCommit": "string",
  - "GoVersion": "string",
  - "OsArch": "string",
  - "Version": "string"
  },
- "Server":
  {
  - "APIVersion": "string",
  - "Built": 0,
  - "BuiltTime": "string",
  - "GitCommit": "string",
  - "GoVersion": "string",
  - "OsArch": "string",
  - "Version": "string"
  }

}`

# containers (compat)

Actions related to containers for the compatibility endpoints

## New Image

Create a new image from a container

##### query Parameters

container | string the name or ID of a container
repo | string the repository name for the created image
tag | string tag name for the created image
comment | string commit message
author | string author of the image
pause | boolean pause the container before committing it
changes | string instructions to apply while committing in Dockerfile format

### Responses

http://podman.io/commit
https://podman.io/commit

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Remove a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

force | boolean Default: false If the container is running, kill it before removing it.
v | boolean Default: false Remove the volumes associated with the container.
link | boolean not supported

### Responses

http://podman.io/containers/{name}
https://podman.io/containers/{name}

### Response samples

- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get files from a container

Get a tar archive of files from a container

##### path Parameters

name required | string container name or id

##### query Parameters

path required | string Path to a directory in the container to extract

### Responses

http://podman.io/containers/{name}/archive
https://podman.io/containers/{name}/archive

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
`"string"`

## Put files into a container

Put a tar archive of files into a container

##### path Parameters

name required | string container name or id

##### query Parameters

path required | string Path to a directory in the container to extract
noOverwriteDirNonDir | string if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa (1 or true)
copyUIDGID | string copy UID/GID maps to the dest file or di (1 or true)

##### Request Body schema:
application/json
application/json
application/x-tar

tarfile of files to copy into the container

string

### Responses

http://podman.io/containers/{name}/archive
https://podman.io/containers/{name}/archive

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`"string"`

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Attach to a container

Hijacks the connection to forward the container's standard streams to the client.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

detachKeys | string keys to use for detaching from the container
logs | boolean Stream all logs from the container across the connection. Happens before streaming attach (if requested). At least one of logs or stream must be set
stream | boolean Default: true Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least one of stream or logs must be set
stdout | boolean Attach to container STDOUT
stderr | boolean Attach to container STDERR
stdin | boolean Attach to container STDIN

### Responses

http://podman.io/containers/{name}/attach
https://podman.io/containers/{name}/attach

### Response samples

- 400
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Export a container

Export the contents of a container as a tarball.

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/containers/{name}/export
https://podman.io/containers/{name}/export

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect container

Return low-level information about a container.

##### path Parameters

name required | string the name or id of the container

##### query Parameters

size | boolean Default: false include the size of the container

### Responses

http://podman.io/containers/{name}/json
https://podman.io/containers/{name}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "AppArmorProfile": "string",
- "Args":
  [
  - "string"
  ],
- "Config":
  {
  - "ArgsEscaped": true,
  - "AttachStderr": true,
  - "AttachStdin": true,
  - "AttachStdout": true,
  - "Cmd":
    [
    - "string"
    ],
  - "Domainname": "string",
  - "Entrypoint":
    [
    - "string"
    ],
  - "Env":
    [
    - "string"
    ],
  - "ExposedPorts":
    {
    - "property1": { },
    - "property2": { }
    },
  - "Healthcheck":
    {
    - "Interval": 0,
    - "Retries": 0,
    - "StartPeriod": 0,
    - "Test":
      [
      - "string"
      ],
    - "Timeout": 0
    },
  - "Hostname": "string",
  - "Image": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "MacAddress": "string",
  - "NetworkDisabled": true,
  - "OnBuild":
    [
    - "string"
    ],
  - "OpenStdin": true,
  - "Shell":
    [
    - "string"
    ],
  - "StdinOnce": true,
  - "StopSignal": "string",
  - "StopTimeout": 0,
  - "Tty": true,
  - "User": "string",
  - "Volumes":
    {
    - "property1": { },
    - "property2": { }
    },
  - "WorkingDir": "string"
  },
- "Created": "string",
- "Driver": "string",
- "ExecIDs":
  [
  - "string"
  ],
- "GraphDriver":
  {
  - "Data":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string"
  },
- "HostConfig":
  {
  - "AutoRemove": true,
  - "Binds":
    [
    - "string"
    ],
  - "BlkioDeviceReadBps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioDeviceReadIOps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioDeviceWriteBps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioDeviceWriteIOps":
    [
    - {
      - "Path": "string",
      - "Rate": 0
      }
    ],
  - "BlkioWeight": 0,
  - "BlkioWeightDevice":
    [
    - {
      - "Path": "string",
      - "Weight": 0
      }
    ],
  - "CapAdd":
    [
    - "string"
    ],
  - "CapDrop":
    [
    - "string"
    ],
  - "Cgroup": "string",
  - "CgroupParent": "string",
  - "CgroupnsMode": "string",
  - "ConsoleSize":
    [
    - 0
    ],
  - "ContainerIDFile": "string",
  - "CpuCount": 0,
  - "CpuPercent": 0,
  - "CpuPeriod": 0,
  - "CpuQuota": 0,
  - "CpuRealtimePeriod": 0,
  - "CpuRealtimeRuntime": 0,
  - "CpuShares": 0,
  - "CpusetCpus": "string",
  - "CpusetMems": "string",
  - "DeviceCgroupRules":
    [
    - "string"
    ],
  - "DeviceRequests":
    [
    - {
      - "Capabilities":
        [
        - [
          - "string"
          ]
        ],
      - "Count": 0,
      - "DeviceIDs":
        [
        - "string"
        ],
      - "Driver": "string",
      - "Options":
        {
        - "property1": "string",
        - "property2": "string"
        }
      }
    ],
  - "Devices":
    [
    - {
      - "CgroupPermissions": "string",
      - "PathInContainer": "string",
      - "PathOnHost": "string"
      }
    ],
  - "Dns":
    [
    - "string"
    ],
  - "DnsOptions":
    [
    - "string"
    ],
  - "DnsSearch":
    [
    - "string"
    ],
  - "ExtraHosts":
    [
    - "string"
    ],
  - "GroupAdd":
    [
    - "string"
    ],
  - "IOMaximumBandwidth": 0,
  - "IOMaximumIOps": 0,
  - "Init": true,
  - "IpcMode": "string",
  - "Isolation": "string",
  - "KernelMemory": 0,
  - "KernelMemoryTCP": 0,
  - "Links":
    [
    - "string"
    ],
  - "LogConfig":
    {
    - "driver": "string",
    - "options":
      {
      - "property1": "string",
      - "property2": "string"
      },
    - "path": "string",
    - "size": 0
    },
  - "MaskedPaths":
    [
    - "string"
    ],
  - "Memory": 0,
  - "MemoryReservation": 0,
  - "MemorySwap": 0,
  - "MemorySwappiness": 0,
  - "Mounts":
    [
    - {
      - "destination": "string",
      - "options":
        [
        - "string"
        ],
      - "source": "string",
      - "type": "string"
      }
    ],
  - "NanoCpus": 0,
  - "NetworkMode": "string",
  - "OomKillDisable": true,
  - "OomScoreAdj": 0,
  - "PidMode": "string",
  - "PidsLimit": 0,
  - "PortBindings":
    {
    - "property1":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ],
    - "property2":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ]
    },
  - "Privileged": true,
  - "PublishAllPorts": true,
  - "ReadonlyPaths":
    [
    - "string"
    ],
  - "ReadonlyRootfs": true,
  - "RestartPolicy":
    {
    - "MaximumRetryCount": 0,
    - "Name": "string"
    },
  - "Runtime": "string",
  - "SecurityOpt":
    [
    - "string"
    ],
  - "ShmSize": 0,
  - "StorageOpt":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Sysctls":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Tmpfs":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "UTSMode": "string",
  - "Ulimits":
    [
    - {
      - "Hard": 0,
      - "Name": "string",
      - "Soft": 0
      }
    ],
  - "UsernsMode": "string",
  - "VolumeDriver": "string",
  - "VolumesFrom":
    [
    - "string"
    ]
  },
- "HostnamePath": "string",
- "HostsPath": "string",
- "Id": "string",
- "Image": "string",
- "LogPath": "string",
- "MountLabel": "string",
- "Mounts":
  [
  - {
    - "Destination": "string",
    - "Driver": "string",
    - "Mode": "string",
    - "Name": "string",
    - "Propagation": "string",
    - "RW": true,
    - "Source": "string",
    - "Type": "string"
    }
  ],
- "Name": "string",
- "NetworkSettings":
  {
  - "Bridge": "string",
  - "EndpointID": "string",
  - "Gateway": "string",
  - "GlobalIPv6Address": "string",
  - "GlobalIPv6PrefixLen": 0,
  - "HairpinMode": true,
  - "IPAddress": "string",
  - "IPPrefixLen": 0,
  - "IPv6Gateway": "string",
  - "LinkLocalIPv6Address": "string",
  - "LinkLocalIPv6PrefixLen": 0,
  - "MacAddress": "string",
  - "Networks":
    {
    - "property1":
      {
      - "Aliases":
        [
        - "string"
        ],
      - "DriverOpts":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "EndpointID": "string",
      - "Gateway": "string",
      - "GlobalIPv6Address": "string",
      - "GlobalIPv6PrefixLen": 0,
      - "IPAMConfig":
        {
        - "IPv4Address": "string",
        - "IPv6Address": "string",
        - "LinkLocalIPs":
          [
          - "string"
          ]
        },
      - "IPAddress": "string",
      - "IPPrefixLen": 0,
      - "IPv6Gateway": "string",
      - "Links":
        [
        - "string"
        ],
      - "MacAddress": "string",
      - "NetworkID": "string"
      },
    - "property2":
      {
      - "Aliases":
        [
        - "string"
        ],
      - "DriverOpts":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "EndpointID": "string",
      - "Gateway": "string",
      - "GlobalIPv6Address": "string",
      - "GlobalIPv6PrefixLen": 0,
      - "IPAMConfig":
        {
        - "IPv4Address": "string",
        - "IPv6Address": "string",
        - "LinkLocalIPs":
          [
          - "string"
          ]
        },
      - "IPAddress": "string",
      - "IPPrefixLen": 0,
      - "IPv6Gateway": "string",
      - "Links":
        [
        - "string"
        ],
      - "MacAddress": "string",
      - "NetworkID": "string"
      }
    },
  - "Ports":
    {
    - "property1":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ],
    - "property2":
      [
      - {
        - "HostIp": "string",
        - "HostPort": "string"
        }
      ]
    },
  - "SandboxID": "string",
  - "SandboxKey": "string",
  - "SecondaryIPAddresses":
    [
    - {
      - "Addr": "string",
      - "PrefixLen": 0
      }
    ],
  - "SecondaryIPv6Addresses":
    [
    - {
      - "Addr": "string",
      - "PrefixLen": 0
      }
    ]
  },
- "Node":
  {
  - "Addr": "string",
  - "Cpus": 0,
  - "ID": "string",
  - "IP": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Memory": 0,
  - "Name": "string"
  },
- "Path": "string",
- "Platform": "string",
- "ProcessLabel": "string",
- "ResolvConfPath": "string",
- "RestartCount": 0,
- "SizeRootFs": 0,
- "SizeRw": 0,
- "State":
  {
  - "Dead": true,
  - "Error": "string",
  - "ExitCode": 0,
  - "FinishedAt": "string",
  - "Health":
    {
    - "FailingStreak": 0,
    - "Log":
      [
      - {
        - "End": "2019-08-24T14:15:22Z",
        - "ExitCode": 0,
        - "Output": "string",
        - "Start": "2019-08-24T14:15:22Z"
        }
      ],
    - "Status": "string"
    },
  - "OOMKilled": true,
  - "Paused": true,
  - "Pid": 0,
  - "Restarting": true,
  - "Running": true,
  - "StartedAt": "string",
  - "Status": "string"
  }

}`

## Kill container

Signal to send to the container as an integer or string (e.g. SIGINT)

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

signal | string Default: "SIGKILL" signal to be sent to container

### Responses

http://podman.io/containers/{name}/kill
https://podman.io/containers/{name}/kill

### Response samples

- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get container logs

Get stdout and stderr logs from a container.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

follow | boolean Keep connection after returning logs.
stdout | boolean Return logs from stdout
stderr | boolean Return logs from stderr
since | string Only return logs since this time, as a UNIX timestamp
until | string Only return logs before this time, as a UNIX timestamp
timestamps | boolean Default: false Add timestamps to every log line
tail | string Default: "all" Only return this number of log lines from the end of the logs

### Responses

http://podman.io/containers/{name}/logs
https://podman.io/containers/{name}/logs

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Pause container

Use the cgroups freezer to suspend all processes in a container.

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/containers/{name}/pause
https://podman.io/containers/{name}/pause

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Rename an existing container

Change the name of an existing container.

##### path Parameters

name required | string Full or partial ID or full name of the container to rename

##### query Parameters

name required | string New name for the container

### Responses

http://podman.io/containers/{name}/rename
https://podman.io/containers/{name}/rename

### Response samples

- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Resize a container's TTY

Resize the terminal attached to a container (for use with Attach).

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

h | integer Height to set for the terminal, in characters
w | integer Width to set for the terminal, in characters

### Responses

http://podman.io/containers/{name}/resize
https://podman.io/containers/{name}/resize

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`{ }`

## Restart container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

t | integer timeout before sending kill signal to container

### Responses

http://podman.io/containers/{name}/restart
https://podman.io/containers/{name}/restart

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Start a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

detachKeys | string Default: "ctrl-p,ctrl-q" Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _.

### Responses

http://podman.io/containers/{name}/start
https://podman.io/containers/{name}/start

### Response samples

- 304
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get stats for a container

This returns a live stream of a container’s resource usage statistics.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

stream | boolean Default: true Stream the output

### Responses

http://podman.io/containers/{name}/stats
https://podman.io/containers/{name}/stats

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Stop a container

Stop a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

t | integer number of seconds to wait before killing container

### Responses

http://podman.io/containers/{name}/stop
https://podman.io/containers/{name}/stop

### Response samples

- 304
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## List processes running inside a container

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

ps_args | string arguments to pass to ps such as aux. Requires ps(1) to be installed in the container if no ps(1) compatible AIX descriptors are used.

### Responses

http://podman.io/containers/{name}/top
https://podman.io/containers/{name}/top

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Processes":
  [
  - [
    - "string"
    ]
  ],
- "Titles":
  [
  - "string"
  ]

}`

## Unpause container

Resume a paused container

##### path Parameters

name required | string the name or ID of the container

### Responses

http://podman.io/containers/{name}/unpause
https://podman.io/containers/{name}/unpause

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Wait on a container

Block until a container stops or given condition is met.

##### path Parameters

name required | string the name or ID of the container

##### query Parameters

condition | string wait until container is to a given condition. default is stopped. valid conditions are: configured created exited paused running stopped

### Responses

http://podman.io/containers/{name}/wait
https://podman.io/containers/{name}/wait

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Error":
  {
  - "Message": "string"
  },
- "StatusCode": 0

}`

## Create a container

##### query Parameters

name | string container name

### Responses

http://podman.io/containers/create
https://podman.io/containers/create

### Response samples

- 201
- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Id": "string",
- "Warnings":
  [
  - "string"
  ]

}`

## List containers

Returns a list of containers

##### query Parameters

all | boolean Default: false Return all containers. By default, only running containers are shown
limit | integer Return this number of most recently created containers, including non-running ones.
size | boolean Default: false Return the size of container as fields SizeRw and SizeRootFs.
filters | string Returns a list of containers. ancestor=([:], , or <image@digest>) before=( or ) expose=([/]|/[]) exited= containers with exit code of health=(starting|healthy|unhealthy|none) id= a container's ID is-task=(true|false) label=key or label="key=value" of a container label name= a container's name network=( or ) publish=([/]|/[]) since=( or ) status=(created|restarting|running|removing|paused|exited|dead) volume=( or )

### Responses

http://podman.io/containers/json
https://podman.io/containers/json

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`{ }`

## Delete stopped containers

Remove containers not in use

##### query Parameters

filters | string Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels.

### Responses

http://podman.io/containers/prune
https://podman.io/containers/prune

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "ContainersDeleted":
    [
    - "string"
    ],
  - "SpaceReclaimed": 0
  }

]`

## Copy files from a container

Copy a tar archive of files from a container

##### path Parameters

name required | string container name or id

##### query Parameters

path required | string Path to a directory in the container to extract

### Responses

http://podman.io/libpod/containers/{name}/archive
https://podman.io/libpod/containers/{name}/archive

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
`"string"`

## Report on changes to container's filesystem; adds, deletes or modifications.

Returns which files in a container's filesystem have been added, deleted, or modified. The Kind of modification can be one of:

0: Modified 1: Added 2: Deleted

##### path Parameters

name required | string the name or id of the container

### Responses

http://podman.io/libpod/containers/{name}/changes
https://podman.io/libpod/containers/{name}/changes

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

# exec (compat)

Actions related to exec for the compatibility endpoints

## Create an exec instance

Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

##### path Parameters

name required | string name of container

##### Request Body schema:
application/json
application/json
application/x-tar

Attributes for create

AttachStderr | boolean Attach to stderr of the exec command
AttachStdin | boolean Attach to stdin of the exec command
AttachStdout | boolean Attach to stdout of the exec command
Cmd | Array of strings Command to run, as a string or array of strings.
DetachKeys | string "Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _."
Env | Array of strings A list of environment variables in the form ["VAR=value", ...]
Privileged | boolean Default: false Runs the exec process with extended privileges
Tty | boolean Allocate a pseudo-TTY
User | string "The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid."
WorkingDir | string The working directory for the exec process inside the container.

### Responses

http://podman.io/containers/{name}/exec
https://podman.io/containers/{name}/exec

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "AttachStderr": true,
- "AttachStdin": true,
- "AttachStdout": true,
- "Cmd":
  [
  - "string"
  ],
- "DetachKeys": "string",
- "Env":
  [
  - "string"
  ],
- "Privileged": false,
- "Tty": true,
- "User": "string",
- "WorkingDir": "string"

}`

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect an exec instance

Return low-level information about an exec instance.

##### path Parameters

id required | string Exec instance ID

### Responses

http://podman.io/exec/{id}/json
https://podman.io/exec/{id}/json

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Resize an exec instance

Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

##### path Parameters

id required | string Exec instance ID

##### query Parameters

h | integer Height of the TTY session in characters
w | integer Width of the TTY session in characters

### Responses

http://podman.io/exec/{id}/resize
https://podman.io/exec/{id}/resize

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Start an exec instance

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

##### path Parameters

id required | string Exec instance ID

##### Request Body schema:
application/json
application/json
application/x-tar

Attributes for start

Detach | boolean Detach from the command. Not presently supported.
Tty | boolean Allocate a pseudo-TTY. Presently ignored.

### Responses

http://podman.io/exec/{id}/start
https://podman.io/exec/{id}/start

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Detach": true,
- "Tty": true

}`

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

# images (compat)

Actions related to images for the compatibility endpoints

## Create image

Build an image from the given Dockerfile(s)

##### query Parameters

dockerfile | string Default: "Dockerfile" Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points to an external `Dockerfile`.
t | string Default: "latest" A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default latest value is assumed. You can provide several t parameters.
extrahosts | string TBD Extra hosts to add to /etc/hosts (As of version 1.xx)
remote | string A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball. (As of version 1.xx)
q | boolean Default: false Suppress verbose build output
nocache | boolean Default: false Do not use the cache when building the image (As of version 1.xx)
cachefrom | string JSON array of images used to build cache resolution (As of version 1.xx)
pull | boolean Default: false Attempt to pull the image even if an older image exists locally (As of version 1.xx)
rm | boolean Default: true Remove intermediate containers after a successful build (As of version 1.xx)
forcerm | boolean Default: false Always remove intermediate containers, even upon failure (As of version 1.xx)
memory | integer Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx)
memswap | integer MemorySwap limits the amount of memory and swap together (As of version 1.xx)
cpushares | integer CPUShares (relative weight (As of version 1.xx)
cpusetcpus | string CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx)
cpuperiod | integer CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx)
cpuquota | integer CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx)
buildargs | string JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `["Foo":"bar"]`. For example, buildargs={"Foo":"bar"}. Note(s): This should not be used to pass secrets. The value of buildargs should be URI component encoded before being passed to the API. (As of version 1.xx)
shmsize | integer Default: 67108864 ShmSize is the "size" value to use when mounting an shmfs on the container's /dev/shm directory. Default is 64MB (As of version 1.xx)
squash | boolean Default: false Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx)
labels | string JSON map of key, value pairs to set as labels on the new image (As of version 1.xx)
networkmode | string Default: "bridge" Sets the networking mode for the run commands during build. Supported standard values are: `bridge` limited to containers within a single host, port mapping required for external access `host` no isolation between host and containers on this network `none` disable all networking for this container container: share networking with given container --All other values are assumed to be a custom network's name (As of version 1.xx)
platform | string Platform format os[/arch[/variant]] (As of version 1.xx)
target | string Target build stage (As of version 1.xx)
outputs | string output configuration TBD (As of version 1.xx)

### Responses

http://podman.io/build
https://podman.io/build

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "stream": "(build details...)\nSuccessfully built 8ba084515c724cbf90d447a63600c0a6\n"

}`

## Remove Image

Delete an image from local storage

##### path Parameters

name:.* required | string name or ID of image to delete

##### query Parameters

force | boolean remove the image even if used by containers or has other tags
noprune | boolean not supported. will be logged as an invalid parameter if enabled

### Responses

http://podman.io/images/{name:.*}
https://podman.io/images/{name:.*}

### Response samples

- 200
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "deleted": "string",
  - "untagged":
    [
    - "string"
    ]
  }

]`

## Export an image

Export an image in tarball format

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/images/{name:.*}/get
https://podman.io/images/{name:.*}/get

### Response samples

- 200
- 500

Content type
application/json
`"string"`

## History of an image

Return parent layers of an image.

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/images/{name:.*}/history
https://podman.io/images/{name:.*}/history

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Comment": "string",
- "Created": 0,
- "CreatedBy": "string",
- "Id": "string",
- "Size": 0,
- "Tags":
  [
  - "string"
  ]

}`

## Inspect an image

Return low-level information about an image.

##### path Parameters

name:.* required | string the name or ID of the container

### Responses

http://podman.io/images/{name:.*}/json
https://podman.io/images/{name:.*}/json

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Architecture": "string",
- "Author": "string",
- "Comment": "string",
- "Config":
  {
  - "ArgsEscaped": true,
  - "AttachStderr": true,
  - "AttachStdin": true,
  - "AttachStdout": true,
  - "Cmd":
    [
    - "string"
    ],
  - "Domainname": "string",
  - "Entrypoint":
    [
    - "string"
    ],
  - "Env":
    [
    - "string"
    ],
  - "ExposedPorts":
    {
    - "property1": { },
    - "property2": { }
    },
  - "Healthcheck":
    {
    - "Interval": 0,
    - "Retries": 0,
    - "StartPeriod": 0,
    - "Test":
      [
      - "string"
      ],
    - "Timeout": 0
    },
  - "Hostname": "string",
  - "Image": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "MacAddress": "string",
  - "NetworkDisabled": true,
  - "OnBuild":
    [
    - "string"
    ],
  - "OpenStdin": true,
  - "Shell":
    [
    - "string"
    ],
  - "StdinOnce": true,
  - "StopSignal": "string",
  - "StopTimeout": 0,
  - "Tty": true,
  - "User": "string",
  - "Volumes":
    {
    - "property1": { },
    - "property2": { }
    },
  - "WorkingDir": "string"
  },
- "Container": "string",
- "ContainerConfig":
  {
  - "ArgsEscaped": true,
  - "AttachStderr": true,
  - "AttachStdin": true,
  - "AttachStdout": true,
  - "Cmd":
    [
    - "string"
    ],
  - "Domainname": "string",
  - "Entrypoint":
    [
    - "string"
    ],
  - "Env":
    [
    - "string"
    ],
  - "ExposedPorts":
    {
    - "property1": { },
    - "property2": { }
    },
  - "Healthcheck":
    {
    - "Interval": 0,
    - "Retries": 0,
    - "StartPeriod": 0,
    - "Test":
      [
      - "string"
      ],
    - "Timeout": 0
    },
  - "Hostname": "string",
  - "Image": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "MacAddress": "string",
  - "NetworkDisabled": true,
  - "OnBuild":
    [
    - "string"
    ],
  - "OpenStdin": true,
  - "Shell":
    [
    - "string"
    ],
  - "StdinOnce": true,
  - "StopSignal": "string",
  - "StopTimeout": 0,
  - "Tty": true,
  - "User": "string",
  - "Volumes":
    {
    - "property1": { },
    - "property2": { }
    },
  - "WorkingDir": "string"
  },
- "Created": "string",
- "DockerVersion": "string",
- "GraphDriver":
  {
  - "Data":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string"
  },
- "Id": "string",
- "Metadata":
  {
  - "LastTagTime": "2019-08-24T14:15:22Z"
  },
- "Os": "string",
- "OsVersion": "string",
- "Parent": "string",
- "RepoDigests":
  [
  - "string"
  ],
- "RepoTags":
  [
  - "string"
  ],
- "RootFS":
  {
  - "Layers":
    [
    - "string"
    ],
  - "Type": "string"
  },
- "Size": 0,
- "Variant": "string",
- "VirtualSize": 0

}`

## Push Image

Push an image to a container registry

##### path Parameters

name:.* required | string Name of image to push.

##### query Parameters

tag | string The tag to associate with the image on the registry.

##### header Parameters

X-Registry-Auth | string A base64-encoded auth configuration.

### Responses

http://podman.io/images/{name:.*}/push
https://podman.io/images/{name:.*}/push

### Response samples

- 200
- 404
- 500

Content type
application/json
`"string"`

## Tag an image

Tag an image so that it becomes part of a repository.

##### path Parameters

name:.* required | string the name or ID of the container

##### query Parameters

repo | string the repository to tag in
tag | string the name of the new tag

### Responses

http://podman.io/images/{name:.*}/tag
https://podman.io/images/{name:.*}/tag

### Response samples

- 400
- 404
- 409
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Create an image

Create an image by either pulling it from a registry or importing it.

##### query Parameters

fromImage | string needs description
fromSrc | string needs description
tag | string needs description

##### header Parameters

X-Registry-Auth | string A base64-encoded auth configuration.

##### Request Body schema:
application/json
application/json
application/x-tar

Image content if fromSrc parameter was used

string

### Responses

http://podman.io/images/create
https://podman.io/images/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`"string"`

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`{ }`

## Export several images

Get a tarball containing all images and metadata for several image repositories

##### query Parameters

names required | string one or more image names or IDs comma separated

### Responses

http://podman.io/images/get
https://podman.io/images/get

### Response samples

- 200
- 500

Content type
application/json
`"string"`

## List Images

Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.

##### query Parameters

all | boolean Default: false Show all images. Only images from a final layer (no children) are shown by default.
filters | string A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) `dangling=true` `label=key` or `label="key=value"` of an image label `reference`=(`<image-name>[:<tag>]`) `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
digests | boolean Default: false Not supported

### Responses

http://podman.io/images/json
https://podman.io/images/json

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "Containers": 0,
  - "Created": 0,
  - "Id": "string",
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "ParentId": "string",
  - "RepoDigests":
    [
    - "string"
    ],
  - "RepoTags":
    [
    - "string"
    ],
  - "SharedSize": 0,
  - "Size": 0,
  - "VirtualSize": 0
  }

]`

## Import image

Load a set of images and tags into a repository.

##### query Parameters

quiet | boolean not supported

##### Request Body schema:
application/json
application/json
application/x-tar

tarball of container image

string

### Responses

http://podman.io/images/load
https://podman.io/images/load

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`"string"`

### Response samples

- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Prune unused images

Remove images from local storage that are not being used by a container

##### query Parameters

filters | string filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters: `dangling=<boolean>` When set to `true` (or `1`), prune only unused and untagged images. When set to `false` (or `0`), all unused images are pruned. `until=<string>` Prune images created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is used) the specified labels.

### Responses

http://podman.io/images/prune
https://podman.io/images/prune

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "deleted": "string",
  - "untagged":
    [
    - "string"
    ]
  }

]`

## Search images

Search registries for an image

##### query Parameters

term | string term to search
limit | integer maximum number of results
filters | string A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: `is-automated=(true|false)` `is-official=(true|false)` `stars=<number>` Matches images that has at least 'number' stars.
listTags | boolean list the available tags in the repository

### Responses

http://podman.io/images/search
https://podman.io/images/search

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Automated": "string",
- "Description": "string",
- "Index": "string",
- "Name": "string",
- "Official": "string",
- "Stars": 0,
- "Tag": "string"

}`

# networks (compat)

Actions related to compatibility networks

## List networks

Display summary of network configurations

##### query Parameters

filters | string JSON encoded value of the filters (a map[string][]string) to process on the network list. Currently available filters: name=[name] Matches network name (accepts regex). id=[id] Matches for full or partial ID. driver=[driver] Only bridge is supported. label=[key] or label=[key=value] Matches networks based on the presence of a label alone or a label and a value.

### Responses

http://podman.io/networks
https://podman.io/networks

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
[

- {
  - "Attachable": true,
  - "ConfigFrom":
    {
    - "Network": "string"
    },
  - "ConfigOnly": true,
  - "Containers":
    {
    - "property1":
      {
      - "EndpointID": "string",
      - "IPv4Address": "string",
      - "IPv6Address": "string",
      - "MacAddress": "string",
      - "Name": "string"
      },
    - "property2":
      {
      - "EndpointID": "string",
      - "IPv4Address": "string",
      - "IPv6Address": "string",
      - "MacAddress": "string",
      - "Name": "string"
      }
    },
  - "Created": "2019-08-24T14:15:22Z",
  - "Driver": "string",
  - "EnableIPv6": true,
  - "IPAM":
    {
    - "Config":
      [
      - {
        - "AuxiliaryAddresses":
          {
          - "property1": "string",
          - "property2": "string"
          },
        - "Gateway": "string",
        - "IPRange": "string",
        - "Subnet": "string"
        }
      ],
    - "Driver": "string",
    - "Options":
      {
      - "property1": "string",
      - "property2": "string"
      }
    },
  - "Id": "string",
  - "Ingress": true,
  - "Internal": true,
  - "Labels":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Name": "string",
  - "Options":
    {
    - "property1": "string",
    - "property2": "string"
    },
  - "Peers":
    [
    - {
      - "IP": "string",
      - "Name": "string"
      }
    ],
  - "Scope": "string",
  - "Services":
    {
    - "property1":
      {
      - "LocalLBIndex": 0,
      - "Ports":
        [
        - "string"
        ],
      - "Tasks":
        [
        - {
          - "EndpointID": "string",
          - "EndpointIP": "string",
          - "Info":
            {
            - "property1": "string",
            - "property2": "string"
            },
          - "Name": "string"
          }
        ],
      - "VIP": "string"
      },
    - "property2":
      {
      - "LocalLBIndex": 0,
      - "Ports":
        [
        - "string"
        ],
      - "Tasks":
        [
        - {
          - "EndpointID": "string",
          - "EndpointIP": "string",
          - "Info":
            {
            - "property1": "string",
            - "property2": "string"
            },
          - "Name": "string"
          }
        ],
      - "VIP": "string"
      }
    }
  }

]`

## Remove a network

Remove a network

##### path Parameters

name required | string the name of the network

### Responses

http://podman.io/networks/{name}
https://podman.io/networks/{name}

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect a network

Display low level configuration network

##### path Parameters

name required | string the name of the network

### Responses

http://podman.io/networks/{name}
https://podman.io/networks/{name}

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Attachable": true,
- "ConfigFrom":
  {
  - "Network": "string"
  },
- "ConfigOnly": true,
- "Containers":
  {
  - "property1":
    {
    - "EndpointID": "string",
    - "IPv4Address": "string",
    - "IPv6Address": "string",
    - "MacAddress": "string",
    - "Name": "string"
    },
  - "property2":
    {
    - "EndpointID": "string",
    - "IPv4Address": "string",
    - "IPv6Address": "string",
    - "MacAddress": "string",
    - "Name": "string"
    }
  },
- "Created": "2019-08-24T14:15:22Z",
- "Driver": "string",
- "EnableIPv6": true,
- "IPAM":
  {
  - "Config":
    [
    - {
      - "AuxiliaryAddresses":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "Gateway": "string",
      - "IPRange": "string",
      - "Subnet": "string"
      }
    ],
  - "Driver": "string",
  - "Options":
    {
    - "property1": "string",
    - "property2": "string"
    }
  },
- "Id": "string",
- "Ingress": true,
- "Internal": true,
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Peers":
  [
  - {
    - "IP": "string",
    - "Name": "string"
    }
  ],
- "Scope": "string",
- "Services":
  {
  - "property1":
    {
    - "LocalLBIndex": 0,
    - "Ports":
      [
      - "string"
      ],
    - "Tasks":
      [
      - {
        - "EndpointID": "string",
        - "EndpointIP": "string",
        - "Info":
          {
          - "property1": "string",
          - "property2": "string"
          },
        - "Name": "string"
        }
      ],
    - "VIP": "string"
    },
  - "property2":
    {
    - "LocalLBIndex": 0,
    - "Ports":
      [
      - "string"
      ],
    - "Tasks":
      [
      - {
        - "EndpointID": "string",
        - "EndpointIP": "string",
        - "Info":
          {
          - "property1": "string",
          - "property2": "string"
          },
        - "Name": "string"
        }
      ],
    - "VIP": "string"
    }
  }

}`

## Connect container to network

Connect a container to a network. This endpoint is current a no-op

##### path Parameters

name required | string the name of the network

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for connecting a container to a network

| object in:body

### Responses

http://podman.io/networks/{name}/connect
https://podman.io/networks/{name}/connect

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Body":
  {
  - "Container": "string",
  - "EndpointConfig":
    {
    - "Aliases":
      [
      - "string"
      ],
    - "DriverOpts":
      {
      - "property1": "string",
      - "property2": "string"
      },
    - "EndpointID": "string",
    - "Gateway": "string",
    - "GlobalIPv6Address": "string",
    - "GlobalIPv6PrefixLen": 0,
    - "IPAMConfig":
      {
      - "IPv4Address": "string",
      - "IPv6Address": "string",
      - "LinkLocalIPs":
        [
        - "string"
        ]
      },
    - "IPAddress": "string",
    - "IPPrefixLen": 0,
    - "IPv6Gateway": "string",
    - "Links":
      [
      - "string"
      ],
    - "MacAddress": "string",
    - "NetworkID": "string"
    }
  }

}`

### Response samples

- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Disconnect container from network

Disconnect a container from a network. This endpoint is current a no-op

##### path Parameters

name required | string the name of the network

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for disconnecting a container from a network

| object in:body

### Responses

http://podman.io/networks/{name}/disconnect
https://podman.io/networks/{name}/disconnect

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Body":
  {
  - "Container": "string",
  - "Force": true
  }

}`

### Response samples

- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Create network

Create a network configuration

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for creating a container

Attachable | boolean
CheckDuplicate | boolean Check for networks with duplicate names. Network is primarily keyed based on a random ID and not on the name. Network name is strictly a user-friendly alias to the network which is uniquely identified using ID. And there is no guaranteed way to check for duplicates. Option CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions.
| object (ConfigReference) ConfigReference specifies the source which provides a network's configuration
ConfigOnly | boolean
Driver | string
EnableIPv6 | boolean
| object (IPAM) IPAM represents IP Address Management
Ingress | boolean
Internal | boolean
| object
Name | string
| object
Scope | string

### Responses

http://podman.io/networks/create
https://podman.io/networks/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Attachable": true,
- "CheckDuplicate": true,
- "ConfigFrom":
  {
  - "Network": "string"
  },
- "ConfigOnly": true,
- "Driver": "string",
- "EnableIPv6": true,
- "IPAM":
  {
  - "Config":
    [
    - {
      - "AuxiliaryAddresses":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "Gateway": "string",
      - "IPRange": "string",
      - "Subnet": "string"
      }
    ],
  - "Driver": "string",
  - "Options":
    {
    - "property1": "string",
    - "property2": "string"
    }
  },
- "Ingress": true,
- "Internal": true,
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Scope": "string"

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Attachable": true,
- "CheckDuplicate": true,
- "ConfigFrom":
  {
  - "Network": "string"
  },
- "ConfigOnly": true,
- "Driver": "string",
- "EnableIPv6": true,
- "IPAM":
  {
  - "Config":
    [
    - {
      - "AuxiliaryAddresses":
        {
        - "property1": "string",
        - "property2": "string"
        },
      - "Gateway": "string",
      - "IPRange": "string",
      - "Subnet": "string"
      }
    ],
  - "Driver": "string",
  - "Options":
    {
    - "property1": "string",
    - "property2": "string"
    }
  },
- "Ingress": true,
- "Internal": true,
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Scope": "string"

}`

## Delete unused networks

Not supported

### Responses

http://podman.io/networks/prune
https://podman.io/networks/prune

### Response samples

- 404

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

# volumes (compat)

Actions related to volumes for the compatibility endpoints

## List volumes

Returns a list of volume

##### query Parameters

filters | string JSON encoded value of the filters (a map[string][]string) to process on the volumes list. Available filters: driver= Matches volumes based on their driver. label= or label=: Matches volumes based on the presence of a label alone or a label and a value. name= Matches all of volume name. Note: The boolean `dangling` filter is not yet implemented for this endpoint.

### Responses

http://podman.io/volumes
https://podman.io/volumes

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "Volumes":
  [
  - {
    - "CreatedAt": "string",
    - "Driver": "string",
    - "Labels":
      {
      - "property1": "string",
      - "property2": "string"
      },
    - "Mountpoint": "string",
    - "Name": "string",
    - "Options":
      {
      - "property1": "string",
      - "property2": "string"
      },
    - "Scope": "string"
    }
  ]

}`

## Remove volume

##### path Parameters

name required | string the name or ID of the volume

##### query Parameters

force | boolean Force removal of the volume. This actually only causes errors due to the names volume not being found to be suppressed, which is the behaviour Docker implements.

### Responses

http://podman.io/volumes/{name}
https://podman.io/volumes/{name}

### Response samples

- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Inspect volume

##### path Parameters

name required | string the name or ID of the volume

### Responses

http://podman.io/volumes/{name}
https://podman.io/volumes/{name}

### Response samples

- 200
- 404
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "CreatedAt": "string",
- "Driver": "string",
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Mountpoint": "string",
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Scope": "string",
- "Status":
  {
  - "property1": { },
  - "property2": { }
  },
- "UsageData":
  {
  - "RefCount": 0,
  - "Size": 0
  }

}`

## Create a volume

##### Request Body schema:
application/json
application/json
application/x-tar

attributes for creating a container. Note: If a volume by the same name exists, a 201 response with that volume's information will be generated.

Driver required | string Name of the volume driver to use.
required | object A mapping of driver options and values. These options are passed directly to the driver and are driver specific.
required | object User-defined key/value metadata.
Name required | string The new volume's name. If not specified, Docker generates a name.

### Responses

http://podman.io/volumes/create
https://podman.io/volumes/create

### Request samples

- Payload

Content type
application/json
application/json
application/x-tar
`
{

- "Driver": "string",
- "DriverOpts":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Name": "string"

}`

### Response samples

- 201
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "CreatedAt": "string",
- "Driver": "string",
- "Labels":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Mountpoint": "string",
- "Name": "string",
- "Options":
  {
  - "property1": "string",
  - "property2": "string"
  },
- "Scope": "string",
- "Status":
  {
  - "property1": { },
  - "property2": { }
  },
- "UsageData":
  {
  - "RefCount": 0,
  - "Size": 0
  }

}`

## Prune volumes

##### query Parameters

filters | string JSON encoded value of filters (a map[string][]string) to match volumes against before pruning. Note: No filters are currently supported and any filters specified will cause an error response.

### Responses

http://podman.io/volumes/prune
https://podman.io/volumes/prune

### Response samples

- 200
- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "SpaceReclaimed": 0,
- "VolumesDeleted":
  [
  - "string"
  ]

}`

# system (compat)

Actions related to Podman and compatibility engines

## Get events

Returns events filtered on query parameters

##### query Parameters

since | string start streaming events from this time
until | string stop streaming events later than this
filters | string JSON encoded map[string][]string of constraints

### Responses

http://podman.io/events
https://podman.io/events

### Response samples

- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Get info

Returns information on the system and libpod configuration

### Responses

http://podman.io/info
https://podman.io/info

### Response samples

- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Ping service

Return protocol information in response headers. `HEAD /libpod/_ping` is also supported. `/_ping` is available for compatibility with other engines. The '_ping' endpoints are not versioned.

### Responses

http://podman.io/libpod/_ping
https://podman.io/libpod/_ping

### Response samples

- 500

Content type
application/json
application/json
text/plain
text/html
`
{

- "cause": "API root cause",
- "message": "human error message",
- "response": 0

}`

## Component Version information

### Responses

http://podman.io/version
https://podman.io/version

### Response samples

- 200

Content type
application/json
application/json
text/plain
text/html
`
{

- "Client":
  {
  - "APIVersion": "string",
  - "Built": 0,
  - "BuiltTime": "string",
  - "GitCommit": "string",
  - "GoVersion": "string",
  - "OsArch": "string",
  - "Version": "string"
  },
- "Server":
  {
  - "APIVersion": "string",
  - "Built": 0,
  - "BuiltTime": "string",
  - "GitCommit": "string",
  - "GoVersion": "string",
  - "OsArch": "string",
  - "Version": "string"
  }

}`