PodsApi

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

Method	HTTP request	Description
generateKubeLibpod_0	GET /libpod/generate/kube	Generate a Kubernetes YAML file.
generateSystemdLibpod_0	GET /libpod/generate/{name}/systemd	Generate Systemd Units
kubeApplyLibpod_0	POST /libpod/kube/apply	Apply a podman workload or Kubernetes YAML file.
playKubeDownLibpod_0	DELETE /libpod/play/kube	Remove resources created from kube play
playKubeLibpod_0	POST /libpod/play/kube	Play a Kubernetes YAML file.
podCreateLibpod	POST /libpod/pods/create	Create a pod
podDeleteLibpod	DELETE /libpod/pods/{name}	Remove pod
podExistsLibpod	GET /libpod/pods/{name}/exists	Pod exists
podInspectLibpod	GET /libpod/pods/{name}/json	Inspect pod
podKillLibpod	POST /libpod/pods/{name}/kill	Kill a pod
podListLibpod	GET /libpod/pods/json	List pods
podPauseLibpod	POST /libpod/pods/{name}/pause	Pause a pod
podPruneLibpod	POST /libpod/pods/prune	Prune unused pods
podRestartLibpod	POST /libpod/pods/{name}/restart	Restart a pod
podStartLibpod	POST /libpod/pods/{name}/start	Start a pod
podStatsAllLibpod	GET /libpod/pods/stats	Statistics for one or more pods
podStopLibpod	POST /libpod/pods/{name}/stop	Stop a pod
podTopLibpod	GET /libpod/pods/{name}/top	List processes
podUnpauseLibpod	POST /libpod/pods/{name}/unpause	Unpause a pod

generateKubeLibpod_0

File generateKubeLibpod_0(names).service(service).type(type).replicas(replicas).noTrunc(noTrunc).podmanOnly(podmanOnly).execute();

Generate a Kubernetes YAML file.

Generate Kubernetes YAML based on a pod or container.

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    List<String> names = Arrays.asList(); // List<String> | Name or ID of the container or pod.
    Boolean service = false; // Boolean | Generate YAML for a Kubernetes service object.
    String type = "pod"; // String | Generate YAML for the given Kubernetes kind.
    Integer replicas = 0; // Integer | Set the replica number for Deployment kind.
    Boolean noTrunc = false; // Boolean | don't truncate annotations to the Kubernetes maximum length of 63 characters
    Boolean podmanOnly = false; // Boolean | add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes)
    try {
      File result = apiInstance.generateKubeLibpod_0(names)
            .service(service)
            .type(type)
            .replicas(replicas)
            .noTrunc(noTrunc)
            .podmanOnly(podmanOnly)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#generateKubeLibpod_0");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
names	List<String>	Name or ID of the container or pod.
service	Boolean	Generate YAML for a Kubernetes service object.	[optional] [default to false]
type	String	Generate YAML for the given Kubernetes kind.	[optional] [default to pod]
replicas	Integer	Set the replica number for Deployment kind.	[optional] [default to 0]
noTrunc	Boolean	don't truncate annotations to the Kubernetes maximum length of 63 characters	[optional] [default to false]
podmanOnly	Boolean	add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes)	[optional] [default to false]

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/vnd.yaml, application/json

HTTP response details

Status code	Description	Response headers
200	Kubernetes YAML file describing pod	-
500	Internal server error	-

generateSystemdLibpod_0

Map<String, String> generateSystemdLibpod_0(name).useName(useName)._new(_new).noHeader(noHeader).startTimeout(startTimeout).stopTimeout(stopTimeout).restartPolicy(restartPolicy).containerPrefix(containerPrefix).podPrefix(podPrefix).separator(separator).restartSec(restartSec).wants(wants).after(after).requires(requires).additionalEnvVariables(additionalEnvVariables).execute();

Generate Systemd Units

Generate Systemd Units based on a pod or container.

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | Name or ID of the container or pod.
    Boolean useName = false; // Boolean | Use container/pod names instead of IDs.
    Boolean _new = false; // Boolean | Create a new container instead of starting an existing one.
    Boolean noHeader = false; // Boolean | Do not generate the header including the Podman version and the timestamp.
    Integer startTimeout = 0; // Integer | Start timeout in seconds.
    Integer stopTimeout = 10; // Integer | Stop timeout in seconds.
    String restartPolicy = "no"; // String | Systemd restart-policy.
    String containerPrefix = "container"; // String | Systemd unit name prefix for containers.
    String podPrefix = "pod"; // String | Systemd unit name prefix for pods.
    String separator = "-"; // String | Systemd unit name separator between name/id and prefix.
    Integer restartSec = 0; // Integer | Configures the time to sleep before restarting a service.
    List<String> wants = Arrays.asList(); // List<String> | Systemd Wants list for the container or pods.
    List<String> after = Arrays.asList(); // List<String> | Systemd After list for the container or pods.
    List<String> requires = Arrays.asList(); // List<String> | Systemd Requires list for the container or pods.
    List<String> additionalEnvVariables = Arrays.asList(); // List<String> | Set environment variables to the systemd unit files.
    try {
      Map<String, String> result = apiInstance.generateSystemdLibpod_0(name)
            .useName(useName)
            ._new(_new)
            .noHeader(noHeader)
            .startTimeout(startTimeout)
            .stopTimeout(stopTimeout)
            .restartPolicy(restartPolicy)
            .containerPrefix(containerPrefix)
            .podPrefix(podPrefix)
            .separator(separator)
            .restartSec(restartSec)
            .wants(wants)
            .after(after)
            .requires(requires)
            .additionalEnvVariables(additionalEnvVariables)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#generateSystemdLibpod_0");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	Name or ID of the container or pod.
useName	Boolean	Use container/pod names instead of IDs.	[optional] [default to false]
_new	Boolean	Create a new container instead of starting an existing one.	[optional] [default to false]
noHeader	Boolean	Do not generate the header including the Podman version and the timestamp.	[optional] [default to false]
startTimeout	Integer	Start timeout in seconds.	[optional] [default to 0]
stopTimeout	Integer	Stop timeout in seconds.	[optional] [default to 10]
restartPolicy	String	Systemd restart-policy.	[optional] [default to on-failure] [enum: no, on-success, on-failure, on-abnormal, on-watchdog, on-abort, always]
containerPrefix	String	Systemd unit name prefix for containers.	[optional] [default to container]
podPrefix	String	Systemd unit name prefix for pods.	[optional] [default to pod]
separator	String	Systemd unit name separator between name/id and prefix.	[optional] [default to -]
restartSec	Integer	Configures the time to sleep before restarting a service.	[optional] [default to 0]
wants	List<String>	Systemd Wants list for the container or pods.	[optional]
after	List<String>	Systemd After list for the container or pods.	[optional]
requires	List<String>	Systemd Requires list for the container or pods.	[optional]
additionalEnvVariables	List<String>	Set environment variables to the systemd unit files.	[optional]

Return type

Map<String, String>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	no error	-
500	Internal server error	-

kubeApplyLibpod_0

File kubeApplyLibpod_0().caCertFile(caCertFile).kubeConfig(kubeConfig).namespace(namespace).service(service)._file(_file).request(request).execute();

Apply a podman workload or Kubernetes YAML file.

Deploy a podman container, pod, volume, or Kubernetes yaml to a Kubernetes cluster.

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String caCertFile = "caCertFile_example"; // String | Path to the CA cert file for the Kubernetes cluster.
    String kubeConfig = "kubeConfig_example"; // String | Path to the kubeconfig file for the Kubernetes cluster.
    String namespace = "namespace_example"; // String | The namespace to deploy the workload to on the Kubernetes cluster.
    Boolean service = true; // Boolean | Create a service object for the container being deployed.
    String _file = "_file_example"; // String | Path to the Kubernetes yaml file to deploy.
    String request = "request_example"; // String | Kubernetes YAML file.
    try {
      File result = apiInstance.kubeApplyLibpod_0()
            .caCertFile(caCertFile)
            .kubeConfig(kubeConfig)
            .namespace(namespace)
            .service(service)
            ._file(_file)
            .request(request)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#kubeApplyLibpod_0");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
caCertFile	String	Path to the CA cert file for the Kubernetes cluster.	[optional]
kubeConfig	String	Path to the kubeconfig file for the Kubernetes cluster.	[optional]
namespace	String	The namespace to deploy the workload to on the Kubernetes cluster.	[optional]
service	Boolean	Create a service object for the container being deployed.	[optional]
_file	String	Path to the Kubernetes yaml file to deploy.	[optional]
request	String	Kubernetes YAML file.	[optional]

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-tar
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Kubernetes YAML file successfully deployed to cluster	-
500	Internal server error	-

playKubeDownLibpod_0

PlayKubeReport playKubeDownLibpod_0().contentType(contentType).force(force).request(request).execute();

Remove resources created from kube play

Tears down pods, secrets, and volumes defined in a YAML file

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String contentType = "text/plain"; // String | 
    Boolean force = false; // Boolean | Remove volumes.
    String request = "request_example"; // String | Kubernetes YAML file.
    try {
      PlayKubeReport result = apiInstance.playKubeDownLibpod_0()
            .contentType(contentType)
            .force(force)
            .request(request)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#playKubeDownLibpod_0");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
contentType	String		[optional] [default to text/plain] [enum: text/plain, application/x-tar]
force	Boolean	Remove volumes.	[optional] [default to false]
request	String	Kubernetes YAML file.	[optional]

Return type

PlayKubeReport

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/x-tar
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PlayKube response	-
500	Internal server error	-

playKubeLibpod_0

PlayKubeReport playKubeLibpod_0().contentType(contentType).annotations(annotations).logDriver(logDriver).logOptions(logOptions).network(network).noHosts(noHosts).noTrunc(noTrunc).publishPorts(publishPorts).publishAllPorts(publishAllPorts).replace(replace).serviceContainer(serviceContainer).start(start).staticIPs(staticIPs).staticMACs(staticMACs).tlsVerify(tlsVerify).userns(userns).wait(wait).build(build).request(request).execute();

Play a Kubernetes YAML file.

Create and run pods based on a Kubernetes YAML file. ### Content-Type Then endpoint support two Content-Type - `text/plain` for yaml format - `application/x-tar` for sending context(s) required for building images #### Tar format The tar format must contain a `play.yaml` file at the root that will be used. If the file format requires context to build an image, it uses the image name and check for corresponding folder. For example, the client sends a tar file with the following structure: ``` └── content.tar ├── play.yaml └── foobar/ └── Containerfile ``` The `play.yaml` is the following, the `foobar` image means we are looking for a context with this name. ``` apiVersion: v1 kind: Pod metadata: name: demo-build-remote spec: containers: - name: container image: foobar ```

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String contentType = "text/plain"; // String | 
    String annotations = "annotations_example"; // String | JSON encoded value of annotations (a map[string]string).
    String logDriver = "logDriver_example"; // String | Logging driver for the containers in the pod.
    List<String> logOptions = Arrays.asList(); // List<String> | logging driver options
    List<String> network = Arrays.asList(); // List<String> | USe the network mode or specify an array of networks.
    Boolean noHosts = false; // Boolean | do not setup /etc/hosts file in container
    Boolean noTrunc = false; // Boolean | use annotations that are not truncated to the Kubernetes maximum length of 63 characters
    List<String> publishPorts = Arrays.asList(); // List<String> | publish a container's port, or a range of ports, to the host
    Boolean publishAllPorts = true; // Boolean | Whether to publish all ports defined in the K8S YAML file (containerPort, hostPort), if false only hostPort will be published
    Boolean replace = false; // Boolean | replace existing pods and containers
    Boolean serviceContainer = false; // Boolean | Starts a service container before all pods.
    Boolean start = true; // Boolean | Start the pod after creating it.
    List<String> staticIPs = Arrays.asList(); // List<String> | Static IPs used for the pods.
    List<String> staticMACs = Arrays.asList(); // List<String> | Static MACs used for the pods.
    Boolean tlsVerify = true; // Boolean | Require HTTPS and verify signatures when contacting registries.
    String userns = "userns_example"; // String | Set the user namespace mode for the pods.
    Boolean wait = false; // Boolean | Clean up all objects created when a SIGTERM is received or pods exit.
    Boolean build = true; // Boolean | Build the images with corresponding context.
    String request = "request_example"; // String | Kubernetes YAML file.
    try {
      PlayKubeReport result = apiInstance.playKubeLibpod_0()
            .contentType(contentType)
            .annotations(annotations)
            .logDriver(logDriver)
            .logOptions(logOptions)
            .network(network)
            .noHosts(noHosts)
            .noTrunc(noTrunc)
            .publishPorts(publishPorts)
            .publishAllPorts(publishAllPorts)
            .replace(replace)
            .serviceContainer(serviceContainer)
            .start(start)
            .staticIPs(staticIPs)
            .staticMACs(staticMACs)
            .tlsVerify(tlsVerify)
            .userns(userns)
            .wait(wait)
            .build(build)
            .request(request)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#playKubeLibpod_0");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
contentType	String		[optional] [default to text/plain] [enum: text/plain, application/x-tar]
annotations	String	JSON encoded value of annotations (a map[string]string).	[optional]
logDriver	String	Logging driver for the containers in the pod.	[optional]
logOptions	List<String>	logging driver options	[optional]
network	List<String>	USe the network mode or specify an array of networks.	[optional]
noHosts	Boolean	do not setup /etc/hosts file in container	[optional] [default to false]
noTrunc	Boolean	use annotations that are not truncated to the Kubernetes maximum length of 63 characters	[optional] [default to false]
publishPorts	List<String>	publish a container's port, or a range of ports, to the host	[optional]
publishAllPorts	Boolean	Whether to publish all ports defined in the K8S YAML file (containerPort, hostPort), if false only hostPort will be published	[optional]
replace	Boolean	replace existing pods and containers	[optional] [default to false]
serviceContainer	Boolean	Starts a service container before all pods.	[optional] [default to false]
start	Boolean	Start the pod after creating it.	[optional] [default to true]
staticIPs	List<String>	Static IPs used for the pods.	[optional]
staticMACs	List<String>	Static MACs used for the pods.	[optional]
tlsVerify	Boolean	Require HTTPS and verify signatures when contacting registries.	[optional] [default to true]
userns	String	Set the user namespace mode for the pods.	[optional]
wait	Boolean	Clean up all objects created when a SIGTERM is received or pods exit.	[optional] [default to false]
build	Boolean	Build the images with corresponding context.	[optional]
request	String	Kubernetes YAML file.	[optional]

Return type

PlayKubeReport

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/x-tar
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PlayKube response	-
500	Internal server error	-

podCreateLibpod

IDResponse podCreateLibpod().create(create).execute();

Create a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    PodSpecGenerator create = new PodSpecGenerator(); // PodSpecGenerator | attributes for creating a pod
    try {
      IDResponse result = apiInstance.podCreateLibpod()
            .create(create)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podCreateLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
create	PodSpecGenerator	attributes for creating a pod	[optional]

Return type

IDResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-tar
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-
400	Bad parameter in request	-
409	status conflict	-
500	Internal server error	-

podDeleteLibpod

PodRmReport podDeleteLibpod(name).force(force).execute();

Remove pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    Boolean force = true; // Boolean | force removal of a running pod by first stopping all containers, then removing all containers in the pod
    try {
      PodRmReport result = apiInstance.podDeleteLibpod(name)
            .force(force)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podDeleteLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod
force	Boolean	force removal of a running pod by first stopping all containers, then removing all containers in the pod	[optional]

Return type

PodRmReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Rm pod	-
400	Bad parameter in request	-
404	No such pod	-
500	Internal server error	-

podExistsLibpod

podExistsLibpod(name).execute();

Pod exists

Check if a pod exists by name or ID

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    try {
      apiInstance.podExistsLibpod(name)
            .execute();
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podExistsLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	pod exists	-
404	No such pod	-
500	Internal server error	-

podInspectLibpod

InspectPodData podInspectLibpod(name).execute();

Inspect pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    try {
      InspectPodData result = apiInstance.podInspectLibpod(name)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podInspectLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod

Return type

InspectPodData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Inspect pod	-
404	No such pod	-
500	Internal server error	-

podKillLibpod

PodKillReport podKillLibpod(name).signal(signal).execute();

Kill a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    String signal = "SIGKILL"; // String | signal to be sent to pod
    try {
      PodKillReport result = apiInstance.podKillLibpod(name)
            .signal(signal)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podKillLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod
signal	String	signal to be sent to pod	[optional] [default to SIGKILL]

Return type

PodKillReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Kill Pod	-
400	Bad parameter in request	-
404	No such pod	-
409	Kill Pod	-
500	Internal server error	-

podListLibpod

List<ListPodsReport> podListLibpod().filters(filters).execute();

List pods

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String filters = "filters_example"; // String | JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters:   - `id=<pod-id>` Matches all of pod id.   - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value.   - `name=<pod-name>` Matches all of pod name.   - `until=<timestamp>` List pods 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.   - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`.   - `network=<pod-network>` Name or full ID of network.   - `ctr-names=<pod-ctr-names>` Container name within the pod.   - `ctr-ids=<pod-ctr-ids>` Container ID within the pod.   - `ctr-status=<pod-ctr-status>` Container status within the pod.   - `ctr-number=<pod-ctr-number>` Number of containers in the pod. 
    try {
      List<ListPodsReport> result = apiInstance.podListLibpod()
            .filters(filters)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podListLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
filters	String	JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters: - `id=<pod-id>` Matches all of pod id. - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value. - `name=<pod-name>` Matches all of pod name. - `until=<timestamp>` List pods 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. - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`. - `network=<pod-network>` Name or full ID of network. - `ctr-names=<pod-ctr-names>` Container name within the pod. - `ctr-ids=<pod-ctr-ids>` Container ID within the pod. - `ctr-status=<pod-ctr-status>` Container status within the pod. - `ctr-number=<pod-ctr-number>` Number of containers in the pod.	[optional]

Return type

List<ListPodsReport>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List pods	-
400	Bad parameter in request	-
500	Internal server error	-

podPauseLibpod

PodPauseReport podPauseLibpod(name).execute();

Pause a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    try {
      PodPauseReport result = apiInstance.podPauseLibpod(name)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podPauseLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod

Return type

PodPauseReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pause pod	-
404	No such pod	-
409	Pause pod	-
500	Internal server error	-

podPruneLibpod

PodPruneReport podPruneLibpod().execute();

Prune unused pods

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    try {
      PodPruneReport result = apiInstance.podPruneLibpod()
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podPruneLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

PodPruneReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Prune pod	-
400	Bad parameter in request	-
409	pod already exists	-
500	Internal server error	-

podRestartLibpod

PodRestartReport podRestartLibpod(name).execute();

Restart a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    try {
      PodRestartReport result = apiInstance.podRestartLibpod(name)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podRestartLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod

Return type

PodRestartReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Restart pod	-
404	No such pod	-
409	Restart pod	-
500	Internal server error	-

podStartLibpod

PodStartReport podStartLibpod(name).execute();

Start a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    try {
      PodStartReport result = apiInstance.podStartLibpod(name)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podStartLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod

Return type

PodStartReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Start pod	-
304	Pod already started	-
404	No such pod	-
409	Start pod	-
500	Internal server error	-

podStatsAllLibpod

List<PodStatsReport> podStatsAllLibpod().all(all).namesOrIDs(namesOrIDs).execute();

Statistics for one or more pods

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

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    Boolean all = true; // Boolean | Provide statistics for all running pods.
    List<String> namesOrIDs = Arrays.asList(); // List<String> | Names or IDs of pods.
    try {
      List<PodStatsReport> result = apiInstance.podStatsAllLibpod()
            .all(all)
            .namesOrIDs(namesOrIDs)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podStatsAllLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
all	Boolean	Provide statistics for all running pods.	[optional]
namesOrIDs	List<String>	Names or IDs of pods.	[optional]

Return type

List<PodStatsReport>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pod Statistics	-
404	No such pod	-
500	Internal server error	-

podStopLibpod

PodStopReport podStopLibpod(name).t(t).execute();

Stop a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    Integer t = 56; // Integer | timeout
    try {
      PodStopReport result = apiInstance.podStopLibpod(name)
            .t(t)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podStopLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod
t	Integer	timeout	[optional]

Return type

PodStopReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Stop pod	-
304	Pod already stopped	-
400	Bad parameter in request	-
404	No such pod	-
409	Stop pod	-
500	Internal server error	-

podTopLibpod

PodTopOKBody podTopLibpod(name).stream(stream).delay(delay).psArgs(psArgs).execute();

List processes

List processes running inside a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | Name of pod to query for processes
    Boolean stream = true; // Boolean | when true, repeatedly stream the latest output (As of version 4.0)
    Integer delay = 5; // Integer | if streaming, delay in seconds between updates. Must be >1. (As of version 4.0)
    String psArgs = "psArgs_example"; // String | arguments to pass to ps such as aux. 
    try {
      PodTopOKBody result = apiInstance.podTopLibpod(name)
            .stream(stream)
            .delay(delay)
            .psArgs(psArgs)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podTopLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	Name of pod to query for processes
stream	Boolean	when true, repeatedly stream the latest output (As of version 4.0)	[optional]
delay	Integer	if streaming, delay in seconds between updates. Must be >1. (As of version 4.0)	[optional] [default to 5]
psArgs	String	arguments to pass to ps such as aux.	[optional]

Return type

PodTopOKBody

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List processes in pod	-
404	No such pod	-
500	Internal server error	-

podUnpauseLibpod

PodUnpauseReport podUnpauseLibpod(name).execute();

Unpause a pod

Example

// Import classes:
import io.github.pod4dev.libpodj.ApiClient;
import io.github.pod4dev.libpodj.ApiException;
import io.github.pod4dev.libpodj.Configuration;
import io.github.pod4dev.libpodj.models.*;
import io.github.pod4dev.libpodj.api.PodsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://podman.io");

    PodsApi apiInstance = new PodsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the pod
    try {
      PodUnpauseReport result = apiInstance.podUnpauseLibpod(name)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PodsApi#podUnpauseLibpod");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
name	String	the name or ID of the pod

Return type

PodUnpauseReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Unpause pod	-
404	No such pod	-
409	Unpause pod	-
500	Internal server error	-

FilesExpand file tree

PodsApi.md

Latest commit

History

PodsApi.md

File metadata and controls

PodsApi

generateKubeLibpod_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generateSystemdLibpod_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

kubeApplyLibpod_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

playKubeDownLibpod_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

playKubeLibpod_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

podCreateLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

podDeleteLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

podExistsLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

podInspectLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

podKillLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

podListLibpod

Example

Parameters