cloudsmith-api

CloudsmithApi - the Ruby gem for the Cloudsmith API

The API to the Cloudsmith Service

This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.61.3
  • Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://help.cloudsmith.io

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudsmith-api.gemspec

Then either install the gem locally:

gem install ./cloudsmith-api-1.61.3.gem

(for development, run gem install --dev ./cloudsmith-api-1.61.3.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 'cloudsmith-api', '~> 1.61.3'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/cloudsmith-io/cloudsmith-api, then add the following in the Gemfile:

gem 'cloudsmith-api', :git => 'https://github.com/cloudsmith-io/cloudsmith-api.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 'cloudsmith-api'

# Setup authorization
CloudsmithApi.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-Api-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
end

api_instance = CloudsmithApi::BadgesApi.new

owner = 'owner_example' # String | 

repo = 'repo_example' # String | 

package_format = 'package_format_example' # String | 

package_name = 'package_name_example' # String | 

package_version = 'package_version_example' # String | 

package_identifiers = 'package_identifiers_example' # String | 

opts = { 
  badge_token: 'badge_token_example', # String | Badge token to authenticate for private packages
  cache_seconds: 'cache_seconds_example', # String | Override the shields.io badge cacheSeconds value.
  color: 'color_example', # String | Override the shields.io badge color value.
  label: 'label_example', # String | Override the shields.io badge label value.
  label_color: 'label_color_example', # String | Override the shields.io badge labelColor value.
  logo_color: 'logo_color_example', # String | Override the shields.io badge logoColor value.
  logo_width: 'logo_width_example', # String | Override the shields.io badge logoWidth value.
  render: true, # BOOLEAN | If true, badge will be rendered
  shields: true, # BOOLEAN | If true, a shields response will be generated
  show_latest: true, # BOOLEAN | If true, for latest version badges a '(latest)' suffix is added
  style: 'style_example' # String | Override the shields.io badge style value.
}

begin
  #Get latest package version for a package or package group.
  result = api_instance.badges_version_list(owner, repo, package_format, package_name, package_version, package_identifiers, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling BadgesApi->badges_version_list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.cloudsmith.io/v1

Class Method HTTP request Description
CloudsmithApi::BadgesApi badges_version_list GET /badges/version/owner/repo/package_format/package_name/package_version/package_identifiers/ Get latest package version for a package or package group.
CloudsmithApi::DistrosApi distros_list GET /distros/ Get a list of all supported distributions.
CloudsmithApi::DistrosApi distros_read GET /distros/slug/ View for viewing/listing distributions.
CloudsmithApi::EntitlementsApi entitlements_create POST /entitlements/owner/repo/ Create a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi entitlements_delete DELETE /entitlements/owner/repo/identifier/ Delete a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi entitlements_disable POST /entitlements/owner/repo/identifier/disable/ Disable an entitlement token in a repository.
CloudsmithApi::EntitlementsApi entitlements_enable POST /entitlements/owner/repo/identifier/enable/ Enable an entitlement token in a repository.
CloudsmithApi::EntitlementsApi entitlements_list GET /entitlements/owner/repo/ Get a list of all entitlements in a repository.
CloudsmithApi::EntitlementsApi entitlements_partial_update PATCH /entitlements/owner/repo/identifier/ Update a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi entitlements_read GET /entitlements/owner/repo/identifier/ Get a specific entitlement in a repository.
CloudsmithApi::EntitlementsApi entitlements_refresh POST /entitlements/owner/repo/identifier/refresh/ Refresh an entitlement token in a repository.
CloudsmithApi::EntitlementsApi entitlements_reset POST /entitlements/owner/repo/identifier/reset/ Reset the statistics for an entitlement token in a repository.
CloudsmithApi::EntitlementsApi entitlements_sync POST /entitlements/owner/repo/sync/ Synchronise tokens from a source repository.
CloudsmithApi::FilesApi files_abort POST /files/owner/repo/identifier/abort/ Abort a multipart file upload.
CloudsmithApi::FilesApi files_complete POST /files/owner/repo/identifier/complete/ Complete a multipart file upload.
CloudsmithApi::FilesApi files_create POST /files/owner/repo/ Request URL(s) to upload new package file upload(s) to.
CloudsmithApi::FilesApi files_info GET /files/owner/repo/identifier/info/ Get upload information for a multipart file upload.
CloudsmithApi::FilesApi files_validate POST /files/owner/repo/validate/ Validate parameters used for create.
CloudsmithApi::FormatsApi formats_list GET /formats/ Get a list of all supported package formats.
CloudsmithApi::FormatsApi formats_read GET /formats/slug/ Get a specific supported package format.
CloudsmithApi::MetricsApi metrics_entitlements_list GET /metrics/entitlements/owner/ View for listing entitlement token metrics, across an account.
CloudsmithApi::MetricsApi metrics_entitlements_list0 GET /metrics/entitlements/owner/repo/ View for listing entitlement token metrics, for a repository.
CloudsmithApi::MetricsApi metrics_packages_list GET /metrics/packages/owner/repo/ View for listing package usage metrics, for a repository.
CloudsmithApi::NamespacesApi namespaces_list GET /namespaces/ Get a list of all namespaces the user belongs to.
CloudsmithApi::NamespacesApi namespaces_read GET /namespaces/slug/ Views for working with namespaces.
CloudsmithApi::OrgsApi orgs_list GET /orgs/ Get a list of all the organizations you are associated with.
CloudsmithApi::OrgsApi orgs_members_list GET /orgs/org/members/ Get the details for all organization members.
CloudsmithApi::OrgsApi orgs_members_read GET /orgs/org/members/member/ Get the details for a specific organization member.
CloudsmithApi::OrgsApi orgs_members_remove GET /orgs/org/members/member/remove/ Removes a member from the organization.
CloudsmithApi::OrgsApi orgs_read GET /orgs/org/ Get the details for the specific organization.
CloudsmithApi::PackagesApi packages_copy POST /packages/owner/repo/identifier/copy/ Copy a package to another repository.
CloudsmithApi::PackagesApi packages_delete DELETE /packages/owner/repo/identifier/ Delete a specific package in a repository.
CloudsmithApi::PackagesApi packages_dependencies GET /packages/owner/repo/identifier/dependencies/ Get the direct (non-transitive) dependencies list for a package.
CloudsmithApi::PackagesApi packages_list GET /packages/owner/repo/ Get a list of all packages associated with repository.
CloudsmithApi::PackagesApi packages_move POST /packages/owner/repo/identifier/move/ Move a package to another repository.
CloudsmithApi::PackagesApi packages_quarantine POST /packages/owner/repo/identifier/quarantine/ Quarantine or restore a package.
CloudsmithApi::PackagesApi packages_read GET /packages/owner/repo/identifier/ Get a specific package in a repository.
CloudsmithApi::PackagesApi packages_resync POST /packages/owner/repo/identifier/resync/ Schedule a package for resynchronisation.
CloudsmithApi::PackagesApi packages_scan POST /packages/owner/repo/identifier/scan/ Schedule a package for scanning.
CloudsmithApi::PackagesApi packages_status GET /packages/owner/repo/identifier/status/ Get the synchronisation status for a package.
CloudsmithApi::PackagesApi packages_tag POST /packages/owner/repo/identifier/tag/ Add/Replace/Remove tags for a package.
CloudsmithApi::PackagesApi packages_upload_alpine POST /packages/owner/repo/upload/alpine/ Create a new Alpine package
CloudsmithApi::PackagesApi packages_upload_cargo POST /packages/owner/repo/upload/cargo/ Create a new Cargo package
CloudsmithApi::PackagesApi packages_upload_cocoapods POST /packages/owner/repo/upload/cocoapods/ Create a new CocoaPods package
CloudsmithApi::PackagesApi packages_upload_composer POST /packages/owner/repo/upload/composer/ Create a new Composer package
CloudsmithApi::PackagesApi packages_upload_conan POST /packages/owner/repo/upload/conan/ Create a new Conan package
CloudsmithApi::PackagesApi packages_upload_conda POST /packages/owner/repo/upload/conda/ Create a new Conda package
CloudsmithApi::PackagesApi packages_upload_cran POST /packages/owner/repo/upload/cran/ Create a new CRAN package
CloudsmithApi::PackagesApi packages_upload_dart POST /packages/owner/repo/upload/dart/ Create a new Dart package
CloudsmithApi::PackagesApi packages_upload_deb POST /packages/owner/repo/upload/deb/ Create a new Debian package
CloudsmithApi::PackagesApi packages_upload_docker POST /packages/owner/repo/upload/docker/ Create a new Docker package
CloudsmithApi::PackagesApi packages_upload_go POST /packages/owner/repo/upload/go/ Create a new Go package
CloudsmithApi::PackagesApi packages_upload_helm POST /packages/owner/repo/upload/helm/ Create a new Helm package
CloudsmithApi::PackagesApi packages_upload_luarocks POST /packages/owner/repo/upload/luarocks/ Create a new LuaRocks package
CloudsmithApi::PackagesApi packages_upload_maven POST /packages/owner/repo/upload/maven/ Create a new Maven package
CloudsmithApi::PackagesApi packages_upload_npm POST /packages/owner/repo/upload/npm/ Create a new npm package
CloudsmithApi::PackagesApi packages_upload_nuget POST /packages/owner/repo/upload/nuget/ Create a new NuGet package
CloudsmithApi::PackagesApi packages_upload_p2 POST /packages/owner/repo/upload/p2/ Create a new P2 package
CloudsmithApi::PackagesApi packages_upload_python POST /packages/owner/repo/upload/python/ Create a new Python package
CloudsmithApi::PackagesApi packages_upload_raw POST /packages/owner/repo/upload/raw/ Create a new Raw package
CloudsmithApi::PackagesApi packages_upload_rpm POST /packages/owner/repo/upload/rpm/ Create a new RedHat package
CloudsmithApi::PackagesApi packages_upload_ruby POST /packages/owner/repo/upload/ruby/ Create a new Ruby package
CloudsmithApi::PackagesApi packages_upload_terraform POST /packages/owner/repo/upload/terraform/ Create a new Terraform package
CloudsmithApi::PackagesApi packages_upload_vagrant POST /packages/owner/repo/upload/vagrant/ Create a new Vagrant package
CloudsmithApi::PackagesApi packages_validate_upload_alpine POST /packages/owner/repo/validate-upload/alpine/ Validate parameters for create Alpine package
CloudsmithApi::PackagesApi packages_validate_upload_cargo POST /packages/owner/repo/validate-upload/cargo/ Validate parameters for create Cargo package
CloudsmithApi::PackagesApi packages_validate_upload_cocoapods POST /packages/owner/repo/validate-upload/cocoapods/ Validate parameters for create CocoaPods package
CloudsmithApi::PackagesApi packages_validate_upload_composer POST /packages/owner/repo/validate-upload/composer/ Validate parameters for create Composer package
CloudsmithApi::PackagesApi packages_validate_upload_conan POST /packages/owner/repo/validate-upload/conan/ Validate parameters for create Conan package
CloudsmithApi::PackagesApi packages_validate_upload_conda POST /packages/owner/repo/validate-upload/conda/ Validate parameters for create Conda package
CloudsmithApi::PackagesApi packages_validate_upload_cran POST /packages/owner/repo/validate-upload/cran/ Validate parameters for create CRAN package
CloudsmithApi::PackagesApi packages_validate_upload_dart POST /packages/owner/repo/validate-upload/dart/ Validate parameters for create Dart package
CloudsmithApi::PackagesApi packages_validate_upload_deb POST /packages/owner/repo/validate-upload/deb/ Validate parameters for create Debian package
CloudsmithApi::PackagesApi packages_validate_upload_docker POST /packages/owner/repo/validate-upload/docker/ Validate parameters for create Docker package
CloudsmithApi::PackagesApi packages_validate_upload_go POST /packages/owner/repo/validate-upload/go/ Validate parameters for create Go package
CloudsmithApi::PackagesApi packages_validate_upload_helm POST /packages/owner/repo/validate-upload/helm/ Validate parameters for create Helm package
CloudsmithApi::PackagesApi packages_validate_upload_luarocks POST /packages/owner/repo/validate-upload/luarocks/ Validate parameters for create LuaRocks package
CloudsmithApi::PackagesApi packages_validate_upload_maven POST /packages/owner/repo/validate-upload/maven/ Validate parameters for create Maven package
CloudsmithApi::PackagesApi packages_validate_upload_npm POST /packages/owner/repo/validate-upload/npm/ Validate parameters for create npm package
CloudsmithApi::PackagesApi packages_validate_upload_nuget POST /packages/owner/repo/validate-upload/nuget/ Validate parameters for create NuGet package
CloudsmithApi::PackagesApi packages_validate_upload_p2 POST /packages/owner/repo/validate-upload/p2/ Validate parameters for create P2 package
CloudsmithApi::PackagesApi packages_validate_upload_python POST /packages/owner/repo/validate-upload/python/ Validate parameters for create Python package
CloudsmithApi::PackagesApi packages_validate_upload_raw POST /packages/owner/repo/validate-upload/raw/ Validate parameters for create Raw package
CloudsmithApi::PackagesApi packages_validate_upload_rpm POST /packages/owner/repo/validate-upload/rpm/ Validate parameters for create RedHat package
CloudsmithApi::PackagesApi packages_validate_upload_ruby POST /packages/owner/repo/validate-upload/ruby/ Validate parameters for create Ruby package
CloudsmithApi::PackagesApi packages_validate_upload_terraform POST /packages/owner/repo/validate-upload/terraform/ Validate parameters for create Terraform package
CloudsmithApi::PackagesApi packages_validate_upload_vagrant POST /packages/owner/repo/validate-upload/vagrant/ Validate parameters for create Vagrant package
CloudsmithApi::QuotaApi quota_history_read GET /quota/history/owner/ Quota history for a given namespace.
CloudsmithApi::QuotaApi quota_oss_history_read GET /quota/oss/history/owner/ Open-source Quota history for a given namespace.
CloudsmithApi::QuotaApi quota_oss_read GET /quota/oss/owner/ Open-source Quota usage for a given namespace.
CloudsmithApi::QuotaApi quota_read GET /quota/owner/ Quota usage for a given namespace.
CloudsmithApi::RatesApi rates_limits_list GET /rates/limits/ Endpoint to check rate limits for current user.
CloudsmithApi::ReposApi repos_all_list GET /repos/ Get a list of all repositories associated with current user.
CloudsmithApi::ReposApi repos_create POST /repos/owner/ Create a new repository in a given namespace.
CloudsmithApi::ReposApi repos_delete DELETE /repos/owner/identifier/ Delete a repository in a given namespace.
CloudsmithApi::ReposApi repos_list GET /repos/owner/ Get a list of all repositories within a namespace.
CloudsmithApi::ReposApi repos_partial_update PATCH /repos/owner/identifier/ Update details about a repository in a given namespace.
CloudsmithApi::ReposApi repos_read GET /repos/owner/identifier/ Get a specific repository.
CloudsmithApi::StatusApi status_check_basic GET /status/check/basic/ Endpoint to check basic API connectivity.
CloudsmithApi::StorageRegionsApi storage_regions_list GET /storage-regions/ Get a list of all available storage regions.
CloudsmithApi::StorageRegionsApi storage_regions_read GET /storage-regions/slug/ Get a specific storage region.
CloudsmithApi::UserApi user_self GET /user/self/ Provide a brief for the current user (if any).
CloudsmithApi::UserApi user_token_create POST /user/token/ Retrieve the API key/token for the authenticated user.
CloudsmithApi::UsersApi users_profile_read GET /users/profile/slug/ Provide a brief for the specified user (if any).
CloudsmithApi::VulnerabilitiesApi vulnerabilities_list GET /vulnerabilities/owner/ Lists scan results for a specific namespace.
CloudsmithApi::VulnerabilitiesApi vulnerabilities_list0 GET /vulnerabilities/owner/repo/ Lists scan results for a specific repository.
CloudsmithApi::VulnerabilitiesApi vulnerabilities_list1 GET /vulnerabilities/owner/repo/package/ Lists scan results for a specific package.
CloudsmithApi::VulnerabilitiesApi vulnerabilities_read GET /vulnerabilities/owner/repo/package/scan_id/ Returns a Scan Result.
CloudsmithApi::WebhooksApi webhooks_create POST /webhooks/owner/repo/ Create a specific webhook in a repository.
CloudsmithApi::WebhooksApi webhooks_delete DELETE /webhooks/owner/repo/identifier/ Delete a specific webhook in a repository.
CloudsmithApi::WebhooksApi webhooks_list GET /webhooks/owner/repo/ Get a list of all webhooks in a repository.
CloudsmithApi::WebhooksApi webhooks_partial_update PATCH /webhooks/owner/repo/identifier/ Update a specific webhook in a repository.
CloudsmithApi::WebhooksApi webhooks_read GET /webhooks/owner/repo/identifier/ Views for working with repository webhooks.

Documentation for Models

Documentation for Authorization

apikey

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

basic

  • Type: HTTP basic authentication