NetworksCompatApi

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

Method	HTTP request	Description
networkConnect	POST /networks/{name}/connect	Connect container to network
networkCreate	POST /networks/create	Create network
networkDelete	DELETE /networks/{name}	Remove a network
networkDisconnect	POST /networks/{name}/disconnect	Disconnect container from network
networkInspect	GET /networks/{name}	Inspect a network
networkList	GET /networks	List networks
networkPrune	POST /networks/prune	Delete unused networks

networkConnect

networkConnect(name).create(create).execute();

Connect container to network

Connect a container to a network

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    String name = "name_example"; // String | the name of the network
    ConnectOptions create = new ConnectOptions(); // ConnectOptions | attributes for connecting a container to a network
    try {
      apiInstance.networkConnect(name)
            .create(create)
            .execute();
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkConnect");
      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 of the network
create	ConnectOptions	attributes for connecting a container to a network	[optional]

Return type

null (empty response body)

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	OK	-
400	Bad parameter in request	-
403	Network is already connected and container is running or transitioning to the running state ('initialized')	-
500	Internal server error	-

networkCreate

NetworkCreate201Response networkCreate().create(create).execute();

Create network

Create a network configuration

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    CreateRequest create = new CreateRequest(); // CreateRequest | attributes for creating a network
    try {
      NetworkCreate201Response result = apiInstance.networkCreate()
            .create(create)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkCreate");
      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	CreateRequest	attributes for creating a network	[optional]

Return type

NetworkCreate201Response

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	network created	-
400	Bad parameter in request	-
500	Internal server error	-

networkDelete

networkDelete(name).execute();

Remove a network

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    String name = "name_example"; // String | the name of the network
    try {
      apiInstance.networkDelete(name)
            .execute();
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkDelete");
      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 of the network

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	no error	-
404	No such network	-
500	Internal server error	-

networkDisconnect

networkDisconnect(name).create(create).execute();

Disconnect container from network

Disconnect a container from a network

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    String name = "name_example"; // String | the name of the network
    DisconnectOptions create = new DisconnectOptions(); // DisconnectOptions | attributes for disconnecting a container from a network
    try {
      apiInstance.networkDisconnect(name)
            .create(create)
            .execute();
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkDisconnect");
      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 of the network
create	DisconnectOptions	attributes for disconnecting a container from a network	[optional]

Return type

null (empty response body)

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	OK	-
400	Bad parameter in request	-
500	Internal server error	-

networkInspect

Inspect networkInspect(name).verbose(verbose).scope(scope).execute();

Inspect a network

Display low level configuration network

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    String name = "name_example"; // String | the name of the network
    Boolean verbose = true; // Boolean | Detailed inspect output for troubleshooting
    String scope = "scope_example"; // String | Filter the network by scope (swarm, global, or local)
    try {
      Inspect result = apiInstance.networkInspect(name)
            .verbose(verbose)
            .scope(scope)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkInspect");
      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 of the network
verbose	Boolean	Detailed inspect output for troubleshooting	[optional]
scope	String	Filter the network by scope (swarm, global, or local)	[optional]

Return type

Inspect

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network inspect	-
404	No such network	-
500	Internal server error	-

networkList

List<Inspect> networkList().filters(filters).execute();

List networks

Display summary of network configurations

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    String filters = "filters_example"; // 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. 
    try {
      List<Inspect> result = apiInstance.networkList()
            .filters(filters)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkList");
      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 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.	[optional]

Return type

List<Inspect>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Network list	-
500	Internal server error	-

networkPrune

NetworkPrune200Response networkPrune().filters(filters).execute();

Delete unused networks

Remove networks that do not have containers

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.NetworksCompatApi;

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

    NetworksCompatApi apiInstance = new NetworksCompatApi(defaultClient);
    String filters = "filters_example"; // String | Filters to process on the prune list, encoded as JSON (a map[string][]string). Available filters:   - `until=<timestamp>` Prune networks 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 networks with (or without, in case `label!=...` is used) the specified labels. 
    try {
      NetworkPrune200Response result = apiInstance.networkPrune()
            .filters(filters)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetworksCompatApi#networkPrune");
      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	Filters to process on the prune list, encoded as JSON (a map[string][]string). Available filters: - `until=<timestamp>` Prune networks 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 networks with (or without, in case `label!=...` is used) the specified labels.	[optional]

Return type

NetworkPrune200Response

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

Files

NetworksCompatApi.md

Latest commit

History

NetworksCompatApi.md

File metadata and controls

NetworksCompatApi

networkConnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

networkCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

networkDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

networkDisconnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

networkInspect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

networkList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

networkPrune

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details