podman-system-service - Man Page

Run an API service

Synopsis

podman system service [options]

Description

The podman system service command creates a listening service that will answer API calls for Podman.  You may optionally provide an endpoint for the API in URI form.  For example, unix://tmp/foobar.sock or tcp:localhost:8080. If no endpoint is provided, defaults will be used.  The default endpoint for a rootful service is unix:/run/podman/podman.sock and rootless is unix:/$XDG_RUNTIME_DIR/podman/podman.sock (for example unix:/run/user/1000/podman/podman.sock)

The REST API provided by podman system service is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer. Documentation for the latter is available at https://docs.podman.io/en/latest/_static/api.html. Both APIs are versioned, but the server will not reject requests with an unsupported version set.

Note: The default systemd unit files (system and user) change the log-level option to info from error. This change provides additional information on each API call.

Options

--time, -t

The time until the session expires in seconds. The default is 5 seconds. A value of 0 means no timeout, therefore the session will not expire.

--help, -h

Print usage statement.

Examples

Run an API listening for 5 seconds using the default socket.

podman system service --timeout 5000

See Also

podman(1), podman-system-service(1), podman-system-connection(1)

History

January 2020, Originally compiled by Brent Baude <bbaude@redhat.com> November 2020, Updated by Jhon Honce (jhonce at redhat dot com)

Referenced By

podman-system(1).

The man page docker-system-service(1) is an alias of podman-system-service(1).