ManifestsApi

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

Method	HTTP request	Description
manifestAddLibpod	POST /libpod/manifests/{name}/add	Add image
manifestCreateLibpod	POST /libpod/manifests/{name}	Create
manifestDeleteLibpod	DELETE /libpod/manifests/{name}	Delete manifest list
manifestExistsLibpod	GET /libpod/manifests/{name}/exists	Exists
manifestInspectLibpod	GET /libpod/manifests/{name}/json	Inspect
manifestModifyLibpod	PUT /libpod/manifests/{name}	Modify manifest list
manifestPushLibpod	POST /libpod/manifests/{name}/registry/{destination}	Push manifest list to registry
manifestPushV3Libpod	POST /libpod/manifests/{name}/push	Push manifest to registry

manifestAddLibpod

IDResponse manifestAddLibpod(name).options(options).execute();

Add image

Add an image to a manifest list Deprecated: As of 4.0.0 use ManifestModifyLibpod instead

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the manifest
    ManifestAddOptions options = new ManifestAddOptions(); // ManifestAddOptions | options for creating a manifest
    try {
      IDResponse result = apiInstance.manifestAddLibpod(name)
            .options(options)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestAddLibpod");
      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 manifest
options	ManifestAddOptions	options for creating a manifest	[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
200		-
404	No such manifest	-
409	Bad parameter in request	-
500	Internal server error	-

manifestCreateLibpod

IDResponse manifestCreateLibpod(name, images).all(all).amend(amend).options(options).execute();

Create

Create a manifest list

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | manifest list or index name to create
    String images = "images_example"; // String | One or more names of an image or a manifest list. Repeat parameter as needed.  Support for multiple images, as of version 4.0.0 Alias of `image` is support for compatibility with < 4.0.0 Response status code is 200 with < 4.0.0 for compatibility 
    Boolean all = true; // Boolean | add all contents if given list
    Boolean amend = true; // Boolean | modify an existing list if one with the desired name already exists
    ManifestModifyOptions options = new ManifestModifyOptions(); // ManifestModifyOptions | options for new manifest
    try {
      IDResponse result = apiInstance.manifestCreateLibpod(name, images)
            .all(all)
            .amend(amend)
            .options(options)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestCreateLibpod");
      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	manifest list or index name to create
images	String	One or more names of an image or a manifest list. Repeat parameter as needed. Support for multiple images, as of version 4.0.0 Alias of `image` is support for compatibility with < 4.0.0 Response status code is 200 with < 4.0.0 for compatibility
all	Boolean	add all contents if given list	[optional]
amend	Boolean	modify an existing list if one with the desired name already exists	[optional]
options	ManifestModifyOptions	options for new manifest	[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	-
404	No such image	-
500	Internal server error	-

manifestDeleteLibpod

LibpodImagesRemoveReport manifestDeleteLibpod(name).ignore(ignore).execute();

Delete manifest list

Delete named manifest list As of v4.0.0

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | The name or ID of the  list to be deleted
    Boolean ignore = true; // Boolean | Ignore if a specified manifest does not exist and do not throw an error.
    try {
      LibpodImagesRemoveReport result = apiInstance.manifestDeleteLibpod(name)
            .ignore(ignore)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestDeleteLibpod");
      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 list to be deleted
ignore	Boolean	Ignore if a specified manifest does not exist and do not throw an error.	[optional]

Return type

LibpodImagesRemoveReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Image Remove	-
404	No such manifest	-
500	Internal server error	-

manifestExistsLibpod

manifestExistsLibpod(name).execute();

Exists

Check if manifest list exists Note: There is no contract that the manifest list will exist for a follow-on operation

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

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

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

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	manifest list exists	-
404	No such manifest	-
500	Internal server error	-

manifestInspectLibpod

Schema2ListPublic manifestInspectLibpod(name).tlsVerify(tlsVerify).execute();

Inspect

Display attributes of given manifest list

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the manifest list
    Boolean tlsVerify = true; // Boolean | Require HTTPS and verify signatures when contacting registries.
    try {
      Schema2ListPublic result = apiInstance.manifestInspectLibpod(name)
            .tlsVerify(tlsVerify)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestInspectLibpod");
      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 manifest list
tlsVerify	Boolean	Require HTTPS and verify signatures when contacting registries.	[optional] [default to true]

Return type

Schema2ListPublic

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

manifestModifyLibpod

ManifestModifyReport manifestModifyLibpod(name, options).tlsVerify(tlsVerify).execute();

Modify manifest list

Add/Remove an image(s) to a manifest list Note: operations are not atomic when multiple Images are provided. As of v4.0.0

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the manifest
    ManifestModifyOptions options = new ManifestModifyOptions(); // ManifestModifyOptions | options for mutating a manifest
    Boolean tlsVerify = true; // Boolean | Require HTTPS and verify signatures when contacting registries.
    try {
      ManifestModifyReport result = apiInstance.manifestModifyLibpod(name, options)
            .tlsVerify(tlsVerify)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestModifyLibpod");
      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 manifest
options	ManifestModifyOptions	options for mutating a manifest
tlsVerify	Boolean	Require HTTPS and verify signatures when contacting registries.	[optional] [default to true]

Return type

ManifestModifyReport

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		-
400	Bad parameter in request	-
404	No such manifest	-
409	Operation had partial success, both Images and Errors may have members	-
500	Internal server error	-

manifestPushLibpod

IDResponse manifestPushLibpod(name, destination).addCompression(addCompression).forceCompressionFormat(forceCompressionFormat).all(all).tlsVerify(tlsVerify).quiet(quiet).execute();

Push manifest list to registry

Push a manifest list or image index to the named registry As of v4.0.0

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the manifest list
    String destination = "destination_example"; // String | the registry for the manifest list
    List<String> addCompression = Arrays.asList(); // List<String> | add existing instances with requested compression algorithms to manifest list
    Boolean forceCompressionFormat = false; // Boolean | Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry.
    Boolean all = true; // Boolean | push all images
    Boolean tlsVerify = true; // Boolean | Require HTTPS and verify signatures when contacting registries.
    Boolean quiet = true; // Boolean | silences extra stream data on push
    try {
      IDResponse result = apiInstance.manifestPushLibpod(name, destination)
            .addCompression(addCompression)
            .forceCompressionFormat(forceCompressionFormat)
            .all(all)
            .tlsVerify(tlsVerify)
            .quiet(quiet)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestPushLibpod");
      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 manifest list
destination	String	the registry for the manifest list
addCompression	List<String>	add existing instances with requested compression algorithms to manifest list	[optional]
forceCompressionFormat	Boolean	Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry.	[optional] [default to false]
all	Boolean	push all images	[optional] [default to true]
tlsVerify	Boolean	Require HTTPS and verify signatures when contacting registries.	[optional] [default to true]
quiet	Boolean	silences extra stream data on push	[optional] [default to true]

Return type

IDResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

manifestPushV3Libpod

IDResponse manifestPushV3Libpod(name, destination).all(all).execute();

Push manifest to registry

Push a manifest list or image index to a registry Deprecated: As of 4.0.0 use ManifestPushLibpod instead

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

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

    ManifestsApi apiInstance = new ManifestsApi(defaultClient);
    String name = "name_example"; // String | the name or ID of the manifest
    String destination = "destination_example"; // String | the destination for the manifest
    Boolean all = true; // Boolean | push all images
    try {
      IDResponse result = apiInstance.manifestPushV3Libpod(name, destination)
            .all(all)
            .execute();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ManifestsApi#manifestPushV3Libpod");
      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 manifest
destination	String	the destination for the manifest
all	Boolean	push all images	[optional]

Return type

IDResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

FilesExpand file tree

ManifestsApi.md

Latest commit

History

ManifestsApi.md

File metadata and controls

ManifestsApi

manifestAddLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestCreateLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestDeleteLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestExistsLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestInspectLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestModifyLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestPushLibpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

manifestPushV3Libpod

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details