Go API client for swagger

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 /var/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

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 0.0.1
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://podman.io/community/

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to http://podman.io/

Class	Method	HTTP request	Description
ContainersApi	ChangesContainer	Get /libpod/containers/{name}/changes	Report on changes to container's filesystem; adds, deletes or modifications.
ContainersApi	LibpodAttachContainer	Post /libpod/containers/{name}/attach	Attach to a container
ContainersApi	LibpodCheckpointContainer	Post /libpod/containers/{name}/checkpoint	Checkpoint a container
ContainersApi	LibpodCommitContainer	Post /libpod/commit	Commit
ContainersApi	LibpodContainerExists	Get /libpod/containers/{name}/exists	Check if container exists
ContainersApi	LibpodCreateContainer	Post /libpod/containers/create	Create a container
ContainersApi	LibpodExportContainer	Get /libpod/containers/{name}/export	Export a container
ContainersApi	LibpodGenerateKube	Get /libpod/generate/{name:.*}/kube	Generate a Kubernetes YAML file.
ContainersApi	LibpodGenerateSystemd	Get /libpod/generate/{name:.*}/systemd	Generate Systemd Units
ContainersApi	LibpodGetContainer	Get /libpod/containers/{name}/json	Inspect container
ContainersApi	LibpodInitContainer	Post /libpod/containers/{name}/init	Initialize a container
ContainersApi	LibpodKillContainer	Post /libpod/containers/{name}/kill	Kill container
ContainersApi	LibpodListContainers	Get /libpod/containers/json	List containers
ContainersApi	LibpodLogsFromContainer	Get /libpod/containers/{name}/logs	Get container logs
ContainersApi	LibpodMountContainer	Post /libpod/containers/{name}/mount	Mount a container
ContainersApi	LibpodPauseContainer	Post /libpod/containers/{name}/pause	Pause a container
ContainersApi	LibpodPlayKube	Post /libpod/play/kube	Play a Kubernetes YAML file.
ContainersApi	LibpodPruneContainers	Post /libpod/containers/prune	Delete stopped containers
ContainersApi	LibpodPutArchive	Post /libpod/containers/{name}/copy	Copy files into a container
ContainersApi	LibpodRemoveContainer	Delete /libpod/containers/{name}	Delete container
ContainersApi	LibpodResizeContainer	Post /libpod/containers/{name}/resize	Resize a container's TTY
ContainersApi	LibpodRestartContainer	Post /libpod/containers/{name}/restart	Restart a container
ContainersApi	LibpodRestoreContainer	Post /libpod/containers/{name}/restore	Restore a container
ContainersApi	LibpodRunHealthCheck	Get /libpod/containers/{name:.*}/healthcheck	Run a container's healthcheck
ContainersApi	LibpodShowMountedContainers	Get /libpod/containers/showmounted	Show mounted containers
ContainersApi	LibpodStartContainer	Post /libpod/containers/{name}/start	Start a container
ContainersApi	LibpodStatsContainer	Get /libpod/containers/{name}/stats	Get stats for a container
ContainersApi	LibpodStatsContainers	Get /libpod/containers/stats	Get stats for one or more containers
ContainersApi	LibpodStopContainer	Post /libpod/containers/{name}/stop	Stop a container
ContainersApi	LibpodTopContainer	Get /libpod/containers/{name}/top	List processes
ContainersApi	LibpodUnmountContainer	Post /libpod/containers/{name}/unmount	Unmount a container
ContainersApi	LibpodUnpauseContainer	Post /libpod/containers/{name}/unpause	Unpause Container
ContainersApi	LibpodWaitContainer	Post /libpod/containers/{name}/wait	Wait on a container
ContainersCompatApi	AttachContainer	Post /containers/{name}/attach	Attach to a container
ContainersCompatApi	ChangesContainer	Get /libpod/containers/{name}/changes	Report on changes to container's filesystem; adds, deletes or modifications.
ContainersCompatApi	CommitContainer	Post /commit	New Image
ContainersCompatApi	CreateContainer	Post /containers/create	Create a container
ContainersCompatApi	ExportContainer	Get /containers/{name}/export	Export a container
ContainersCompatApi	GetArchive	Get /containers/{name}/archive	Get files from a container
ContainersCompatApi	GetContainer	Get /containers/{name}/json	Inspect container
ContainersCompatApi	KillContainer	Post /containers/{name}/kill	Kill container
ContainersCompatApi	LibpodGetArchive	Get /libpod/containers/{name}/copy	Copy files from a container
ContainersCompatApi	ListContainers	Get /containers/json	List containers
ContainersCompatApi	LogsFromContainer	Get /containers/{name}/logs	Get container logs
ContainersCompatApi	PauseContainer	Post /containers/{name}/pause	Pause container
ContainersCompatApi	PruneContainers	Post /containers/prune	Delete stopped containers
ContainersCompatApi	PutArchive	Put /containers/{name}/archive	Put files into a container
ContainersCompatApi	RemoveContainer	Delete /containers/{name}	Remove a container
ContainersCompatApi	ResizeContainer	Post /containers/{name}/resize	Resize a container's TTY
ContainersCompatApi	RestartContainer	Post /containers/{name}/restart	Restart container
ContainersCompatApi	StartContainer	Post /containers/{name}/start	Start a container
ContainersCompatApi	StatsContainer	Get /containers/{name}/stats	Get stats for a container
ContainersCompatApi	StopContainer	Post /containers/{name}/stop	Stop a container
ContainersCompatApi	TopContainer	Get /containers/{name}/top	List processes running inside a container
ContainersCompatApi	UnpauseContainer	Post /containers/{name}/unpause	Unpause container
ContainersCompatApi	WaitContainer	Post /containers/{name}/wait	Wait on a container
ExecApi	LibpodCreateExec	Post /libpod/containers/{name}/exec	Create an exec instance
ExecApi	LibpodInspectExec	Get /libpod/exec/{id}/json	Inspect an exec instance
ExecApi	LibpodResizeExec	Post /libpod/exec/{id}/resize	Resize an exec instance
ExecApi	LibpodStartExec	Post /libpod/exec/{id}/start	Start an exec instance
ExecCompatApi	CreateExec	Post /containers/{name}/exec	Create an exec instance
ExecCompatApi	InspectExec	Get /exec/{id}/json	Inspect an exec instance
ExecCompatApi	ResizeExec	Post /exec/{id}/resize	Resize an exec instance
ExecCompatApi	StartExec	Post /exec/{id}/start	Start an exec instance
ImagesApi	LibpodBuildImage	Post /libpod/build	Create image
ImagesApi	LibpodChangesImages	Get /libpod/images/{name}/changes	Report on changes to images's filesystem; adds, deletes or modifications.
ImagesApi	LibpodExportImage	Get /libpod/images/{name:.*}/get	Export an image
ImagesApi	LibpodExportImages	Get /libpod/images/export	Export multiple images
ImagesApi	LibpodImageExists	Get /libpod/images/{name:.*}/exists	Image exists
ImagesApi	LibpodImageHistory	Get /libpod/images/{name:.*}/history	History of an image
ImagesApi	LibpodImageTree	Get /libpod/images/{name:.*}/tree	Image tree
ImagesApi	LibpodImagesImport	Post /libpod/images/import	Import image
ImagesApi	LibpodImagesLoad	Post /libpod/images/load	Load image
ImagesApi	LibpodImagesPull	Post /libpod/images/pull	Pull images
ImagesApi	LibpodImagesRemove	Delete /libpod/images/remove	Remove one or more images from the storage.
ImagesApi	LibpodInspectImage	Get /libpod/images/{name:.*}/json	Inspect an image
ImagesApi	LibpodListImages	Get /libpod/images/json	List Images
ImagesApi	LibpodPruneImages	Post /libpod/images/prune	Prune unused images
ImagesApi	LibpodPushImage	Post /libpod/images/{name:.*}/push	Push Image
ImagesApi	LibpodRemoveImage	Delete /libpod/images/{name:.*}	Remove an image from the local storage.
ImagesApi	LibpodSearchImages	Get /libpod/images/search	Search images
ImagesApi	LibpodTagImage	Post /libpod/images/{name:.*}/tag	Tag an image
ImagesApi	LibpodUntagImage	Post /libpod/images/{name:.*}/untag	Untag an image
ImagesCompatApi	BuildImage	Post /build	Create image
ImagesCompatApi	CreateImage	Post /images/create	Create an image
ImagesCompatApi	ExportImage	Get /images/{name:.*}/get	Export an image
ImagesCompatApi	ImageHistory	Get /images/{name:.*}/history	History of an image
ImagesCompatApi	ImportImage	Post /images/load	Import image
ImagesCompatApi	InspectImage	Get /images/{name:.*}/json	Inspect an image
ImagesCompatApi	ListImages	Get /images/json	List Images
ImagesCompatApi	PruneImages	Post /images/prune	Prune unused images
ImagesCompatApi	PushImage	Post /images/{name:.*}/push	Push Image
ImagesCompatApi	RemoveImage	Delete /images/{name:.*}	Remove Image
ImagesCompatApi	SearchImages	Get /images/search	Search images
ImagesCompatApi	TagImage	Post /images/{name:.*}/tag	Tag an image
ManifestsApi	AddManifest	Post /libpod/manifests/{name:.*}/add
ManifestsApi	Create	Post /libpod/manifests/create	Create
ManifestsApi	Inspect	Get /libpod/manifests/{name:.*}/json	Inspect
ManifestsApi	PushManifest	Post /libpod/manifests/{name}/push	Push
ManifestsApi	RemoveManifest	Delete /libpod/manifests/{name:.*}	Remove
NetworksApi	LibpodCreateNetwork	Post /libpod/networks/create	Create network
NetworksApi	LibpodInspectNetwork	Get /libpod/networks/{name}/json	Inspect a network
NetworksApi	LibpodListNetwork	Get /libpod/networks/json	List networks
NetworksApi	LibpodRemoveNetwork	Delete /libpod/networks/{name}	Remove a network
NetworksCompatApi	CompatCreateNetwork	Post /networks/create	Create network
NetworksCompatApi	CompatInspectNetwork	Get /networks/{name}	Inspect a network
NetworksCompatApi	CompatListNetwork	Get /networks	List networks
NetworksCompatApi	CompatRemoveNetwork	Delete /networks/{name}	Remove a network
PodsApi	CreatePod	Post /libpod/pods/create	Create a pod
PodsApi	InspectPod	Get /libpod/pods/{name}/json	Inspect pod
PodsApi	KillPod	Post /libpod/pods/{name}/kill	Kill a pod
PodsApi	LibpodGenerateKube	Get /libpod/generate/{name:.*}/kube	Generate a Kubernetes YAML file.
PodsApi	LibpodGenerateSystemd	Get /libpod/generate/{name:.*}/systemd	Generate Systemd Units
PodsApi	LibpodPlayKube	Post /libpod/play/kube	Play a Kubernetes YAML file.
PodsApi	ListPods	Get /libpod/pods/json	List pods
PodsApi	PausePod	Post /libpod/pods/{name}/pause	Pause a pod
PodsApi	PodExists	Get /libpod/pods/{name}/exists	Pod exists
PodsApi	PrunePods	Post /libpod/pods/prune	Prune unused pods
PodsApi	RemovePod	Delete /libpod/pods/{name}	Remove pod
PodsApi	RestartPod	Post /libpod/pods/{name}/restart	Restart a pod
PodsApi	StartPod	Post /libpod/pods/{name}/start	Start a pod
PodsApi	StatsPod	Get /libpod/pods/stats	Get stats for one or more pods
PodsApi	StopPod	Post /libpod/pods/{name}/stop	Stop a pod
PodsApi	TopPod	Get /libpod/pods/{name}/top	List processes
PodsApi	UnpausePod	Post /libpod/pods/{name}/unpause	Unpause a pod
SystemApi	Df	Get /libpod/system/df	Show disk usage
SystemApi	LibpodGetEvents	Get /libpod/events	Get events
SystemApi	LibpodGetInfo	Get /libpod/info	Get info
SystemApi	LibpodPingGet	Get /libpod/_ping	Ping service
SystemApi	PruneSystem	Post /libpod/system/prune	Prune unused data
SystemApi	SystemVersion	Get /libpod/version	Component Version information
SystemCompatApi	CompatSystemVersion	Get /version	Component Version information
SystemCompatApi	GetEvents	Get /events	Get events
SystemCompatApi	GetInfo	Get /info	Get info
SystemCompatApi	LibpodPingGet	Get /libpod/_ping	Ping service
VolumesApi	LibpodCreateVolume	Post /libpod/volumes/create	Create a volume
VolumesApi	LibpodInspectVolume	Get /libpod/volumes/{name}/json	Inspect volume
VolumesApi	LibpodListVolumes	Get /libpod/volumes/json	List volumes
VolumesApi	LibpodPruneVolumes	Post /libpod/volumes/prune	Prune volumes
VolumesApi	LibpodRemoveVolume	Delete /libpod/volumes/{name}	Remove volume
VolumesCompatApi	CreateVolume	Post /volumes/create	Create a volume
VolumesCompatApi	InspectVolume	Get /volumes/{name}	Inspect volume
VolumesCompatApi	ListVolumes	Get /volumes	List volumes
VolumesCompatApi	PruneVolumes	Post /volumes/prune	Prune volumes
VolumesCompatApi	RemoveVolume	Delete /volumes/{name}	Remove volume

# README

Go API client for swagger

Overview

Installation

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

Author