API version: v3
Package version: 2.26.0
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://pulpproject.org

Installation

Build a gem

To build the Ruby code into a gem:

gem build pulp_container_client.gemspec

Then either install the gem locally:

gem install ./pulp_container_client-2.26.0.gem

(for development, run gem install --dev ./pulp_container_client-2.26.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pulp_container_client', '~> 2.26.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pulp_container_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pulp_container_client'

# Setup authorization
PulpContainerClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = PulpContainerClient::ContentBlobsApi.new
opts = {
  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
  digest: 'digest_example', # String | Filter results where digest matches value
  digest__in: ['inner_example'], # Array<String> | Filter results where digest is in a comma-separated list of values
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  ordering: ['-digest'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `digest` - Digest * `-digest` - Digest (descending) * `pk` - Pk * `-pk` - Pk (descending)
  orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
}

begin
  #List blobs
  result = api_instance.list(opts)
  p result
rescue PulpContainerClient::ApiError => e
  puts "Exception when calling ContentBlobsApi->list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:24817

Class	Method	HTTP request	Description
PulpContainerClient::ContentBlobsApi	list	GET /pulp/api/v3/content/container/blobs/	List blobs
PulpContainerClient::ContentBlobsApi	read	GET {container_blob_href}	Inspect a blob
PulpContainerClient::ContentBlobsApi	set_label	POST {container_blob_href}set_label/	Set a label
PulpContainerClient::ContentBlobsApi	unset_label	POST {container_blob_href}unset_label/	Unset a label
PulpContainerClient::ContentManifestsApi	list	GET /pulp/api/v3/content/container/manifests/	List manifests
PulpContainerClient::ContentManifestsApi	read	GET {container_manifest_href}	Inspect a manifest
PulpContainerClient::ContentManifestsApi	set_label	POST {container_manifest_href}set_label/	Set a label
PulpContainerClient::ContentManifestsApi	unset_label	POST {container_manifest_href}unset_label/	Unset a label
PulpContainerClient::ContentSignaturesApi	list	GET /pulp/api/v3/content/container/signatures/	List manifest signatures
PulpContainerClient::ContentSignaturesApi	read	GET {container_manifest_signature_href}	Inspect a manifest signature
PulpContainerClient::ContentSignaturesApi	set_label	POST {container_manifest_signature_href}set_label/	Set a label
PulpContainerClient::ContentSignaturesApi	unset_label	POST {container_manifest_signature_href}unset_label/	Unset a label
PulpContainerClient::ContentTagsApi	list	GET /pulp/api/v3/content/container/tags/	List tags
PulpContainerClient::ContentTagsApi	read	GET {container_tag_href}	Inspect a tag
PulpContainerClient::ContentTagsApi	set_label	POST {container_tag_href}set_label/	Set a label
PulpContainerClient::ContentTagsApi	unset_label	POST {container_tag_href}unset_label/	Unset a label
PulpContainerClient::DistributionsContainerApi	add_role	POST {container_container_distribution_href}add_role/	Add a role
PulpContainerClient::DistributionsContainerApi	create	POST /pulp/api/v3/distributions/container/container/	Create a container distribution
PulpContainerClient::DistributionsContainerApi	delete	DELETE {container_container_distribution_href}	Delete a container distribution
PulpContainerClient::DistributionsContainerApi	list	GET /pulp/api/v3/distributions/container/container/	List container distributions
PulpContainerClient::DistributionsContainerApi	list_roles	GET {container_container_distribution_href}list_roles/	List roles
PulpContainerClient::DistributionsContainerApi	my_permissions	GET {container_container_distribution_href}my_permissions/	List user permissions
PulpContainerClient::DistributionsContainerApi	partial_update	PATCH {container_container_distribution_href}	Update a container distribution
PulpContainerClient::DistributionsContainerApi	read	GET {container_container_distribution_href}	Inspect a container distribution
PulpContainerClient::DistributionsContainerApi	remove_role	POST {container_container_distribution_href}remove_role/	Remove a role
PulpContainerClient::DistributionsContainerApi	set_label	POST {container_container_distribution_href}set_label/	Set a label
PulpContainerClient::DistributionsContainerApi	unset_label	POST {container_container_distribution_href}unset_label/	Unset a label
PulpContainerClient::DistributionsContainerApi	update	PUT {container_container_distribution_href}	Update a container distribution
PulpContainerClient::DistributionsPullThroughApi	add_role	POST {container_container_pull_through_distribution_href}add_role/	Add a role
PulpContainerClient::DistributionsPullThroughApi	create	POST /pulp/api/v3/distributions/container/pull-through/	Create a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	delete	DELETE {container_container_pull_through_distribution_href}	Delete a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	list	GET /pulp/api/v3/distributions/container/pull-through/	List container pull through distributions
PulpContainerClient::DistributionsPullThroughApi	list_roles	GET {container_container_pull_through_distribution_href}list_roles/	List roles
PulpContainerClient::DistributionsPullThroughApi	my_permissions	GET {container_container_pull_through_distribution_href}my_permissions/	List user permissions
PulpContainerClient::DistributionsPullThroughApi	partial_update	PATCH {container_container_pull_through_distribution_href}	Update a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	read	GET {container_container_pull_through_distribution_href}	Inspect a container pull through distribution
PulpContainerClient::DistributionsPullThroughApi	remove_role	POST {container_container_pull_through_distribution_href}remove_role/	Remove a role
PulpContainerClient::DistributionsPullThroughApi	set_label	POST {container_container_pull_through_distribution_href}set_label/	Set a label
PulpContainerClient::DistributionsPullThroughApi	unset_label	POST {container_container_pull_through_distribution_href}unset_label/	Unset a label
PulpContainerClient::DistributionsPullThroughApi	update	PUT {container_container_pull_through_distribution_href}	Update a container pull through distribution
PulpContainerClient::PulpContainerNamespacesApi	add_role	POST {container_container_namespace_href}add_role/	Add a role
PulpContainerClient::PulpContainerNamespacesApi	create	POST /pulp/api/v3/pulp_container/namespaces/	Create a container namespace
PulpContainerClient::PulpContainerNamespacesApi	delete	DELETE {container_container_namespace_href}	Delete a container namespace
PulpContainerClient::PulpContainerNamespacesApi	list	GET /pulp/api/v3/pulp_container/namespaces/	List container namespaces
PulpContainerClient::PulpContainerNamespacesApi	list_roles	GET {container_container_namespace_href}list_roles/	List roles
PulpContainerClient::PulpContainerNamespacesApi	my_permissions	GET {container_container_namespace_href}my_permissions/	List user permissions
PulpContainerClient::PulpContainerNamespacesApi	read	GET {container_container_namespace_href}	Inspect a container namespace
PulpContainerClient::PulpContainerNamespacesApi	remove_role	POST {container_container_namespace_href}remove_role/	Remove a role
PulpContainerClient::RemotesContainerApi	add_role	POST {container_container_remote_href}add_role/	Add a role
PulpContainerClient::RemotesContainerApi	create	POST /pulp/api/v3/remotes/container/container/	Create a container remote
PulpContainerClient::RemotesContainerApi	delete	DELETE {container_container_remote_href}	Delete a container remote
PulpContainerClient::RemotesContainerApi	list	GET /pulp/api/v3/remotes/container/container/	List container remotes
PulpContainerClient::RemotesContainerApi	list_roles	GET {container_container_remote_href}list_roles/	List roles
PulpContainerClient::RemotesContainerApi	my_permissions	GET {container_container_remote_href}my_permissions/	List user permissions
PulpContainerClient::RemotesContainerApi	partial_update	PATCH {container_container_remote_href}	Update a container remote
PulpContainerClient::RemotesContainerApi	read	GET {container_container_remote_href}	Inspect a container remote
PulpContainerClient::RemotesContainerApi	remove_role	POST {container_container_remote_href}remove_role/	Remove a role
PulpContainerClient::RemotesContainerApi	set_label	POST {container_container_remote_href}set_label/	Set a label
PulpContainerClient::RemotesContainerApi	unset_label	POST {container_container_remote_href}unset_label/	Unset a label
PulpContainerClient::RemotesContainerApi	update	PUT {container_container_remote_href}	Update a container remote
PulpContainerClient::RemotesPullThroughApi	add_role	POST {container_container_pull_through_remote_href}add_role/	Add a role
PulpContainerClient::RemotesPullThroughApi	create	POST /pulp/api/v3/remotes/container/pull-through/	Create a container pull through remote
PulpContainerClient::RemotesPullThroughApi	delete	DELETE {container_container_pull_through_remote_href}	Delete a container pull through remote
PulpContainerClient::RemotesPullThroughApi	list	GET /pulp/api/v3/remotes/container/pull-through/	List container pull through remotes
PulpContainerClient::RemotesPullThroughApi	list_roles	GET {container_container_pull_through_remote_href}list_roles/	List roles
PulpContainerClient::RemotesPullThroughApi	my_permissions	GET {container_container_pull_through_remote_href}my_permissions/	List user permissions
PulpContainerClient::RemotesPullThroughApi	partial_update	PATCH {container_container_pull_through_remote_href}	Update a container pull through remote
PulpContainerClient::RemotesPullThroughApi	read	GET {container_container_pull_through_remote_href}	Inspect a container pull through remote
PulpContainerClient::RemotesPullThroughApi	remove_role	POST {container_container_pull_through_remote_href}remove_role/	Remove a role
PulpContainerClient::RemotesPullThroughApi	set_label	POST {container_container_pull_through_remote_href}set_label/	Set a label
PulpContainerClient::RemotesPullThroughApi	unset_label	POST {container_container_pull_through_remote_href}unset_label/	Unset a label
PulpContainerClient::RemotesPullThroughApi	update	PUT {container_container_pull_through_remote_href}	Update a container pull through remote
PulpContainerClient::RepositoriesContainerApi	add	POST {container_container_repository_href}add/	Add content
PulpContainerClient::RepositoriesContainerApi	add_role	POST {container_container_repository_href}add_role/	Add a role
PulpContainerClient::RepositoriesContainerApi	build_image	POST {container_container_repository_href}build_image/	Build an Image
PulpContainerClient::RepositoriesContainerApi	copy_manifests	POST {container_container_repository_href}copy_manifests/	Copy manifests
PulpContainerClient::RepositoriesContainerApi	copy_tags	POST {container_container_repository_href}copy_tags/	Copy tags
PulpContainerClient::RepositoriesContainerApi	create	POST /pulp/api/v3/repositories/container/container/	Create a container repository
PulpContainerClient::RepositoriesContainerApi	delete	DELETE {container_container_repository_href}	Delete a container repository
PulpContainerClient::RepositoriesContainerApi	list	GET /pulp/api/v3/repositories/container/container/	List container repositorys
PulpContainerClient::RepositoriesContainerApi	list_roles	GET {container_container_repository_href}list_roles/	List roles
PulpContainerClient::RepositoriesContainerApi	my_permissions	GET {container_container_repository_href}my_permissions/	List user permissions
PulpContainerClient::RepositoriesContainerApi	partial_update	PATCH {container_container_repository_href}	Update a container repository
PulpContainerClient::RepositoriesContainerApi	read	GET {container_container_repository_href}	Inspect a container repository
PulpContainerClient::RepositoriesContainerApi	remove	POST {container_container_repository_href}remove/	Remove content
PulpContainerClient::RepositoriesContainerApi	remove_role	POST {container_container_repository_href}remove_role/	Remove a role
PulpContainerClient::RepositoriesContainerApi	set_label	POST {container_container_repository_href}set_label/	Set a label
PulpContainerClient::RepositoriesContainerApi	sign	POST {container_container_repository_href}sign/	Sign images in the repo
PulpContainerClient::RepositoriesContainerApi	sync	POST {container_container_repository_href}sync/	Sync from a remote
PulpContainerClient::RepositoriesContainerApi	tag	POST {container_container_repository_href}tag/	Create a Tag
PulpContainerClient::RepositoriesContainerApi	unset_label	POST {container_container_repository_href}unset_label/	Unset a label
PulpContainerClient::RepositoriesContainerApi	untag	POST {container_container_repository_href}untag/	Delete a tag
PulpContainerClient::RepositoriesContainerApi	update	PUT {container_container_repository_href}	Update a container repository
PulpContainerClient::RepositoriesContainerPushApi	add_role	POST {container_container_push_repository_href}add_role/	Add a role
PulpContainerClient::RepositoriesContainerPushApi	list	GET /pulp/api/v3/repositories/container/container-push/	List container push repositorys
PulpContainerClient::RepositoriesContainerPushApi	list_roles	GET {container_container_push_repository_href}list_roles/	List roles
PulpContainerClient::RepositoriesContainerPushApi	my_permissions	GET {container_container_push_repository_href}my_permissions/	List user permissions
PulpContainerClient::RepositoriesContainerPushApi	partial_update	PATCH {container_container_push_repository_href}	Update a container push repository
PulpContainerClient::RepositoriesContainerPushApi	read	GET {container_container_push_repository_href}	Inspect a container push repository
PulpContainerClient::RepositoriesContainerPushApi	remove_image	POST {container_container_push_repository_href}remove_image/	Delete an image from a repository
PulpContainerClient::RepositoriesContainerPushApi	remove_role	POST {container_container_push_repository_href}remove_role/	Remove a role
PulpContainerClient::RepositoriesContainerPushApi	remove_signatures	POST {container_container_push_repository_href}remove_signatures/
PulpContainerClient::RepositoriesContainerPushApi	sign	POST {container_container_push_repository_href}sign/	Sign images in the repo
PulpContainerClient::RepositoriesContainerPushApi	tag	POST {container_container_push_repository_href}tag/	Create a Tag
PulpContainerClient::RepositoriesContainerPushApi	untag	POST {container_container_push_repository_href}untag/	Delete a tag
PulpContainerClient::RepositoriesContainerPushApi	update	PUT {container_container_push_repository_href}	Update a container push repository
PulpContainerClient::RepositoriesContainerPushVersionsApi	delete	DELETE {container_container_push_repository_version_href}	Delete a repository version
PulpContainerClient::RepositoriesContainerPushVersionsApi	list	GET {container_container_push_repository_href}versions/	List repository versions
PulpContainerClient::RepositoriesContainerPushVersionsApi	read	GET {container_container_push_repository_version_href}	Inspect a repository version
PulpContainerClient::RepositoriesContainerPushVersionsApi	repair	POST {container_container_push_repository_version_href}repair/
PulpContainerClient::RepositoriesContainerVersionsApi	delete	DELETE {container_container_repository_version_href}	Delete a repository version
PulpContainerClient::RepositoriesContainerVersionsApi	list	GET {container_container_repository_href}versions/	List repository versions
PulpContainerClient::RepositoriesContainerVersionsApi	read	GET {container_container_repository_version_href}	Inspect a repository version
PulpContainerClient::RepositoriesContainerVersionsApi	repair	POST {container_container_repository_version_href}repair/
PulpContainerClient::TokenApi	get	GET /token/

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

Type: HTTP basic authentication

FAQs

What is pulp_container_client?

Is pulp_container_client well maintained?

Package last updated on 14 Aug 2025

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

pulp_container_client