github.com/containers/podman/v2@v2.2.2-0.20210501105131-c1e07d070c4c/pkg/api/server/docs.go (about)

     1  // Package api Provides a container compatible interface.
     2  //
     3  // This documentation describes the Podman v2.0 RESTful API.
     4  // It replaces the Podman v1.0 API and was initially delivered
     5  // along with Podman v2.0.  It consists of a Docker-compatible
     6  // API and a Libpod API providing support for Podman’s unique
     7  // features such as pods.
     8  //
     9  // To start the service and keep it running for 5,000 seconds (-t 0 runs forever):
    10  //
    11  //    podman system service -t 5000 &
    12  //
    13  // You can then use cURL on the socket using requests documented below.
    14  //
    15  // NOTE: if you install the package podman-docker, it will create a symbolic
    16  // link for /var/run/docker.sock to /run/podman/podman.sock
    17  //
    18  // See podman-service(1) for more information.
    19  //
    20  //  Quick Examples:
    21  //
    22  //   'podman info'
    23  //
    24  //      curl --unix-socket /run/podman/podman.sock http://d/v1.0.0/libpod/info
    25  //
    26  //   'podman pull quay.io/containers/podman'
    27  //
    28  //      curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman'
    29  //
    30  //   'podman list images'
    31  //
    32  //      curl --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/libpod/images/json' | jq
    33  //
    34  // Terms Of Service:
    35  //
    36  //     Schemes: http, https
    37  //     Host: podman.io
    38  //     BasePath: /
    39  //     Version: 0.0.1
    40  //     License: Apache-2.0 https://opensource.org/licenses/Apache-2.0
    41  //     Contact: Podman <podman@lists.podman.io> https://podman.io/community/
    42  //
    43  //     InfoExtensions:
    44  //     x-logo:
    45  //       - url: https://raw.githubusercontent.com/containers/libpod/master/logo/podman-logo.png
    46  //       - altText: "Podman logo"
    47  //
    48  //     Produces:
    49  //     - application/json
    50  //     - text/plain
    51  //     - text/html
    52  //
    53  //     Consumes:
    54  //     - application/json
    55  //     - application/x-tar
    56  // swagger:meta
    57  package server