Skip to content

README.md

Latest commit

 

History

History
754 lines (701 loc) · 79 KB

README.md

File metadata and controls

754 lines (701 loc) · 79 KB

cloudsmith-api

Cloudsmith API (v1)

  • API version: v1

The API to the Cloudsmith Service

For more information, please visit https://help.cloudsmith.io

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.cloudsmith.api</groupId>
  <artifactId>cloudsmith-api</artifactId>
  <version>2.0.23</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.cloudsmith.api:cloudsmith-api:2.0.23"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/cloudsmith-api-2.0.23.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.cloudsmith.api.*;
import io.cloudsmith.api.auth.*;
import io.cloudsmith.api.models.*;
import io.cloudsmith.api.apis.AuditLogApi;

import java.io.File;
import java.util.*;

public class AuditLogApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apikey
        ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
        apikey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apikey.setApiKeyPrefix("Token");

        // Configure HTTP basic authorization: basic
        HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
        basic.setUsername("YOUR USERNAME");
        basic.setPassword("YOUR PASSWORD");

        AuditLogApi apiInstance = new AuditLogApi();
        String owner = "owner_example"; // String | 
        java.math.BigInteger page = new java.math.BigInteger(); // java.math.BigInteger | A page number within the paginated result set.
        java.math.BigInteger pageSize = new java.math.BigInteger(); // java.math.BigInteger | Number of results to return per page.
        String query = "query_example"; // String | A search term for querying events, actors, or timestamps of log records.
        try {
            List<NamespaceAuditLog> result = apiInstance.auditLogNamespaceList(owner, page, pageSize, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogApi#auditLogNamespaceList");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AuditLogApi auditLogNamespaceList GET /audit-log/{owner}/ Lists audit log entries for a specific namespace.
AuditLogApi auditLogRepoList GET /audit-log/{owner}/{repo}/ Lists audit log entries for a specific repository.
BadgesApi badgesVersionList GET /badges/version/{owner}/{repo}/{package_format}/{package_name}/{package_version}/{package_identifiers}/ Get latest package version for a package or package group.
BroadcastsApi broadcastsCreateBroadcastToken POST /broadcasts/{org}/broadcast-token/ Create a broadcast token.
DistrosApi distrosList GET /distros/ Get a list of all supported distributions.
DistrosApi distrosRead GET /distros/{slug}/ View for viewing/listing distributions.
EntitlementsApi entitlementsCreate POST /entitlements/{owner}/{repo}/ Create a specific entitlement in a repository.
EntitlementsApi entitlementsDelete DELETE /entitlements/{owner}/{repo}/{identifier}/ Delete a specific entitlement in a repository.
EntitlementsApi entitlementsDisable POST /entitlements/{owner}/{repo}/{identifier}/disable/ Disable an entitlement token in a repository.
EntitlementsApi entitlementsEnable POST /entitlements/{owner}/{repo}/{identifier}/enable/ Enable an entitlement token in a repository.
EntitlementsApi entitlementsList GET /entitlements/{owner}/{repo}/ Get a list of all entitlements in a repository.
EntitlementsApi entitlementsPartialUpdate PATCH /entitlements/{owner}/{repo}/{identifier}/ Update a specific entitlement in a repository.
EntitlementsApi entitlementsRead GET /entitlements/{owner}/{repo}/{identifier}/ Get a specific entitlement in a repository.
EntitlementsApi entitlementsRefresh POST /entitlements/{owner}/{repo}/{identifier}/refresh/ Refresh an entitlement token in a repository.
EntitlementsApi entitlementsReset POST /entitlements/{owner}/{repo}/{identifier}/reset/ Reset the statistics for an entitlement token in a repository.
EntitlementsApi entitlementsSync POST /entitlements/{owner}/{repo}/sync/ Synchronise tokens from a source repository.
FilesApi filesAbort POST /files/{owner}/{repo}/{identifier}/abort/ Abort a multipart file upload.
FilesApi filesComplete POST /files/{owner}/{repo}/{identifier}/complete/ Complete a multipart file upload.
FilesApi filesCreate POST /files/{owner}/{repo}/ Request URL(s) to upload new package file upload(s) to.
FilesApi filesInfo GET /files/{owner}/{repo}/{identifier}/info/ Get upload information to perform a multipart file upload.
FilesApi filesValidate POST /files/{owner}/{repo}/validate/ Validate parameters used for create.
FormatsApi formatsList GET /formats/ Get a list of all supported package formats.
FormatsApi formatsRead GET /formats/{slug}/ Get a specific supported package format.
MetricsApi metricsEntitlementsAccountList GET /metrics/entitlements/{owner}/ View for listing entitlement token metrics, across an account.
MetricsApi metricsEntitlementsRepoList GET /metrics/entitlements/{owner}/{repo}/ View for listing entitlement token metrics, for a repository.
MetricsApi metricsPackagesList GET /metrics/packages/{owner}/{repo}/ View for listing package usage metrics, for a repository.
NamespacesApi namespacesList GET /namespaces/ Get a list of all namespaces the user belongs to.
NamespacesApi namespacesRead GET /namespaces/{slug}/ Get a specific namespace that the user belongs to.
OrgsApi orgsDelete DELETE /orgs/{org}/ Delete the specified organization.
OrgsApi orgsDenyPolicyCreate POST /orgs/{org}/deny-policy/ Create a package deny policy.
OrgsApi orgsDenyPolicyDelete DELETE /orgs/{org}/deny-policy/{slug_perm}/ Delete a package deny policy.
OrgsApi orgsDenyPolicyList GET /orgs/{org}/deny-policy/ Get a list of all package deny policies.
OrgsApi orgsDenyPolicyPartialUpdate PATCH /orgs/{org}/deny-policy/{slug_perm}/ Partially update a package deny policy.
OrgsApi orgsDenyPolicyRead GET /orgs/{org}/deny-policy/{slug_perm}/ Get a package deny policy.
OrgsApi orgsDenyPolicyUpdate PUT /orgs/{org}/deny-policy/{slug_perm}/ Update a package deny policy.
OrgsApi orgsInvitesCreate POST /orgs/{org}/invites/ Create an organization invite for a specific user
OrgsApi orgsInvitesDelete DELETE /orgs/{org}/invites/{slug_perm}/ Delete a specific organization invite
OrgsApi orgsInvitesExtend POST /orgs/{org}/invites/{slug_perm}/extend/ Extend an organization invite.
OrgsApi orgsInvitesList GET /orgs/{org}/invites/ Get a list of all invites for an organization.
OrgsApi orgsInvitesPartialUpdate PATCH /orgs/{org}/invites/{slug_perm}/ Update a specific organization invite.
OrgsApi orgsInvitesResend POST /orgs/{org}/invites/{slug_perm}/resend/ Resend an organization invite.
OrgsApi orgsLicensePolicyCreate POST /orgs/{org}/license-policy/ Create a package license policy.
OrgsApi orgsLicensePolicyDelete DELETE /orgs/{org}/license-policy/{slug_perm}/ Delete a package license policy.
OrgsApi orgsLicensePolicyEvaluationCreate POST /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/ Create an evaluation request for this policy.
OrgsApi orgsLicensePolicyEvaluationList GET /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/ List evaluation requests for this policy.
OrgsApi orgsLicensePolicyEvaluationRead GET /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/{slug_perm}/ Retrieve an evaluation request for this policy.
OrgsApi orgsLicensePolicyList GET /orgs/{org}/license-policy/ Get a list of all package license policies.
OrgsApi orgsLicensePolicyPartialUpdate PATCH /orgs/{org}/license-policy/{slug_perm}/ Partially update a package license policy.
OrgsApi orgsLicensePolicyRead GET /orgs/{org}/license-policy/{slug_perm}/ Get a package license policy.
OrgsApi orgsLicensePolicyUpdate PUT /orgs/{org}/license-policy/{slug_perm}/ Update a package license policy.
OrgsApi orgsLicensePolicyViolationList GET /orgs/{org}/license-policy-violation/ List all current license policy violations for this Organization.
OrgsApi orgsList GET /orgs/ Get a list of all the organizations you are associated with.
OrgsApi orgsMembersDelete DELETE /orgs/{org}/members/{member}/ Removes a member from the organization.
OrgsApi orgsMembersList GET /orgs/{org}/members/ Get the details for all organization members.
OrgsApi orgsMembersPartialUpdate PATCH /orgs/{org}/members/{member}/ Views for working with organization members.
OrgsApi orgsMembersRead GET /orgs/{org}/members/{member}/ Get the details for a specific organization member.
OrgsApi orgsMembersRefresh POST /orgs/{org}/members/{member}/refresh/ Refresh a member of the organization's API key.
OrgsApi orgsMembersRemove GET /orgs/{org}/members/{member}/remove/ Removes a member from the organization (deprecated, use DELETE instead).
OrgsApi orgsMembersUpdateRole PATCH /orgs/{org}/members/{member}/update-role/ Update a member's role in the organization.
OrgsApi orgsMembersUpdateVisibility PATCH /orgs/{org}/members/{member}/update-visibility/ Update a member's visibility in the organization.
OrgsApi orgsOpenidConnectCreate POST /orgs/{org}/openid-connect/ Create the OpenID Connect provider settings for the org.
OrgsApi orgsOpenidConnectDelete DELETE /orgs/{org}/openid-connect/{slug_perm}/ Delete a specific OpenID Connect provider setting for the org.
OrgsApi orgsOpenidConnectDynamicMappingsList GET /orgs/{org}/openid-connect/{provider_setting}/dynamic-mappings/ Retrieve the list of OpenID Connect dynamic mappings for the provider setting.
OrgsApi orgsOpenidConnectDynamicMappingsRead GET /orgs/{org}/openid-connect/{provider_setting}/dynamic-mappings/{claim_value}/ Retrieve a specific OpenID Connect dynamic mapping for the provider setting.
OrgsApi orgsOpenidConnectList GET /orgs/{org}/openid-connect/ Retrieve the list of OpenID Connect provider settings for the org.
OrgsApi orgsOpenidConnectPartialUpdate PATCH /orgs/{org}/openid-connect/{slug_perm}/ Update a specific OpenID Connect provider setting for the org.
OrgsApi orgsOpenidConnectRead GET /orgs/{org}/openid-connect/{slug_perm}/ Retrieve a specific OpenID Connect provider setting for the org.
OrgsApi orgsOpenidConnectUpdate PUT /orgs/{org}/openid-connect/{slug_perm}/ Update a specific OpenID Connect provider setting for the org.
OrgsApi orgsRead GET /orgs/{org}/ Get the details for the specific organization.
OrgsApi orgsSamlAuthenticationPartialUpdate PATCH /orgs/{org}/saml-authentication Update the SAML Authentication settings for this Organization.
OrgsApi orgsSamlAuthenticationRead GET /orgs/{org}/saml-authentication Retrieve the SAML Authentication settings for this Organization.
OrgsApi orgsSamlGroupSyncCreate POST /orgs/{org}/saml-group-sync/ Create a new SAML Group Sync mapping within an organization.
OrgsApi orgsSamlGroupSyncDelete DELETE /orgs/{org}/saml-group-sync/{slug_perm}/ Delete a SAML Group Sync mapping from an organization.
OrgsApi orgsSamlGroupSyncDisable POST /orgs/{org}/saml-group-sync/disable/ Disable SAML Group Sync for this organization.
OrgsApi orgsSamlGroupSyncEnable POST /orgs/{org}/saml-group-sync/enable/ Enable SAML Group Sync for this organization.
OrgsApi orgsSamlGroupSyncList GET /orgs/{org}/saml-group-sync/ Get the details of all SAML Group Sync mapping within an organization.
OrgsApi orgsSamlGroupSyncStatus GET /orgs/{org}/saml-group-sync/status/ Retrieve the SAML Group Sync status for this organization.
OrgsApi orgsServicesCreate POST /orgs/{org}/services/ Create a service within an organization.
OrgsApi orgsServicesDelete DELETE /orgs/{org}/services/{service}/ Delete a specific service
OrgsApi orgsServicesList GET /orgs/{org}/services/ Get a list of all services within an organization.
OrgsApi orgsServicesPartialUpdate PATCH /orgs/{org}/services/{service}/ Update a service within an organization.
OrgsApi orgsServicesRead GET /orgs/{org}/services/{service}/ Retrieve details of a single service within an organization.
OrgsApi orgsServicesRefresh POST /orgs/{org}/services/{service}/refresh/ Refresh service API token.
OrgsApi orgsTeamsCreate POST /orgs/{org}/teams/ Create a team for this organization.
OrgsApi orgsTeamsDelete DELETE /orgs/{org}/teams/{team}/ Delete a specific team in a organization.
OrgsApi orgsTeamsList GET /orgs/{org}/teams/ Get the details of all teams within an organization.
OrgsApi orgsTeamsMembersCreate POST /orgs/{org}/teams/{team}/members Add users to a team.
OrgsApi orgsTeamsMembersList GET /orgs/{org}/teams/{team}/members List all members for the team.
OrgsApi orgsTeamsMembersUpdate PUT /orgs/{org}/teams/{team}/members Replace all team members.
OrgsApi orgsTeamsPartialUpdate PATCH /orgs/{org}/teams/{team}/ Update a specific team in a organization.
OrgsApi orgsTeamsRead GET /orgs/{org}/teams/{team}/ Get the details of a specific team within an organization.
OrgsApi orgsVulnerabilityPolicyCreate POST /orgs/{org}/vulnerability-policy/ Create a package vulnerability policy.
OrgsApi orgsVulnerabilityPolicyDelete DELETE /orgs/{org}/vulnerability-policy/{slug_perm}/ Delete a package vulnerability policy.
OrgsApi orgsVulnerabilityPolicyEvaluationCreate POST /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/ Create an evaluation request for this policy.
OrgsApi orgsVulnerabilityPolicyEvaluationList GET /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/ List evaluation requests for this policy.
OrgsApi orgsVulnerabilityPolicyEvaluationRead GET /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/{slug_perm}/ Retrieve an evaluation request for this policy.
OrgsApi orgsVulnerabilityPolicyList GET /orgs/{org}/vulnerability-policy/ Get a list of all package vulnerability policies.
OrgsApi orgsVulnerabilityPolicyPartialUpdate PATCH /orgs/{org}/vulnerability-policy/{slug_perm}/ Partially update a package vulnerability policy.
OrgsApi orgsVulnerabilityPolicyRead GET /orgs/{org}/vulnerability-policy/{slug_perm}/ Get a package vulnerability policy.
OrgsApi orgsVulnerabilityPolicyUpdate PUT /orgs/{org}/vulnerability-policy/{slug_perm}/ Update a package vulnerability policy.
OrgsApi orgsVulnerabilityPolicyViolationList GET /orgs/{org}/vulnerability-policy-violation/ List all current vulnerability policy violations for this Organization.
PackagesApi packagesCopy POST /packages/{owner}/{repo}/{identifier}/copy/ Copy a package to another repository.
PackagesApi packagesDelete DELETE /packages/{owner}/{repo}/{identifier}/ Delete a specific package in a repository.
PackagesApi packagesDependencies GET /packages/{owner}/{repo}/{identifier}/dependencies/ Get the list of dependencies for a package. Transitive dependencies are included where supported.
PackagesApi packagesGroupsList GET /packages/{owner}/{repo}/groups/ Return a list of Package Groups in a repository.
PackagesApi packagesList GET /packages/{owner}/{repo}/ Get a list of all packages associated with repository.
PackagesApi packagesMove POST /packages/{owner}/{repo}/{identifier}/move/ Move a package to another repository.
PackagesApi packagesQuarantine POST /packages/{owner}/{repo}/{identifier}/quarantine/ Quarantine or release a package.
PackagesApi packagesRead GET /packages/{owner}/{repo}/{identifier}/ Get a specific package in a repository.
PackagesApi packagesResync POST /packages/{owner}/{repo}/{identifier}/resync/ Schedule a package for resynchronisation.
PackagesApi packagesScan POST /packages/{owner}/{repo}/{identifier}/scan/ Schedule a package for scanning.
PackagesApi packagesStatus GET /packages/{owner}/{repo}/{identifier}/status/ Get the synchronization status for a package.
PackagesApi packagesTag POST /packages/{owner}/{repo}/{identifier}/tag/ Add/Replace/Remove tags for a package.
PackagesApi packagesUpdateLicense PATCH /packages/{owner}/{repo}/{identifier}/update-license/ Update the license for a package.
PackagesApi packagesUploadAlpine POST /packages/{owner}/{repo}/upload/alpine/ Create a new Alpine package
PackagesApi packagesUploadCargo POST /packages/{owner}/{repo}/upload/cargo/ Create a new Cargo package
PackagesApi packagesUploadCocoapods POST /packages/{owner}/{repo}/upload/cocoapods/ Create a new CocoaPods package
PackagesApi packagesUploadComposer POST /packages/{owner}/{repo}/upload/composer/ Create a new Composer package
PackagesApi packagesUploadConan POST /packages/{owner}/{repo}/upload/conan/ Create a new Conan package
PackagesApi packagesUploadConda POST /packages/{owner}/{repo}/upload/conda/ Create a new Conda package
PackagesApi packagesUploadCran POST /packages/{owner}/{repo}/upload/cran/ Create a new CRAN package
PackagesApi packagesUploadDart POST /packages/{owner}/{repo}/upload/dart/ Create a new Dart package
PackagesApi packagesUploadDeb POST /packages/{owner}/{repo}/upload/deb/ Create a new Debian package
PackagesApi packagesUploadDocker POST /packages/{owner}/{repo}/upload/docker/ Create a new Docker package
PackagesApi packagesUploadGo POST /packages/{owner}/{repo}/upload/go/ Create a new Go package
PackagesApi packagesUploadHelm POST /packages/{owner}/{repo}/upload/helm/ Create a new Helm package
PackagesApi packagesUploadHex POST /packages/{owner}/{repo}/upload/hex/ Create a new Hex package
PackagesApi packagesUploadHuggingface POST /packages/{owner}/{repo}/upload/huggingface/ Create a new HuggingFace package
PackagesApi packagesUploadLuarocks POST /packages/{owner}/{repo}/upload/luarocks/ Create a new LuaRocks package
PackagesApi packagesUploadMaven POST /packages/{owner}/{repo}/upload/maven/ Create a new Maven package
PackagesApi packagesUploadNpm POST /packages/{owner}/{repo}/upload/npm/ Create a new npm package
PackagesApi packagesUploadNuget POST /packages/{owner}/{repo}/upload/nuget/ Create a new NuGet package
PackagesApi packagesUploadP2 POST /packages/{owner}/{repo}/upload/p2/ Create a new P2 package
PackagesApi packagesUploadPython POST /packages/{owner}/{repo}/upload/python/ Create a new Python package
PackagesApi packagesUploadRaw POST /packages/{owner}/{repo}/upload/raw/ Create a new Raw package
PackagesApi packagesUploadRpm POST /packages/{owner}/{repo}/upload/rpm/ Create a new RedHat package
PackagesApi packagesUploadRuby POST /packages/{owner}/{repo}/upload/ruby/ Create a new Ruby package
PackagesApi packagesUploadSwift POST /packages/{owner}/{repo}/upload/swift/ Create a new Swift package
PackagesApi packagesUploadTerraform POST /packages/{owner}/{repo}/upload/terraform/ Create a new Terraform package
PackagesApi packagesUploadVagrant POST /packages/{owner}/{repo}/upload/vagrant/ Create a new Vagrant package
PackagesApi packagesValidateUploadAlpine POST /packages/{owner}/{repo}/validate-upload/alpine/ Validate parameters for create Alpine package
PackagesApi packagesValidateUploadCargo POST /packages/{owner}/{repo}/validate-upload/cargo/ Validate parameters for create Cargo package
PackagesApi packagesValidateUploadCocoapods POST /packages/{owner}/{repo}/validate-upload/cocoapods/ Validate parameters for create CocoaPods package
PackagesApi packagesValidateUploadComposer POST /packages/{owner}/{repo}/validate-upload/composer/ Validate parameters for create Composer package
PackagesApi packagesValidateUploadConan POST /packages/{owner}/{repo}/validate-upload/conan/ Validate parameters for create Conan package
PackagesApi packagesValidateUploadConda POST /packages/{owner}/{repo}/validate-upload/conda/ Validate parameters for create Conda package
PackagesApi packagesValidateUploadCran POST /packages/{owner}/{repo}/validate-upload/cran/ Validate parameters for create CRAN package
PackagesApi packagesValidateUploadDart POST /packages/{owner}/{repo}/validate-upload/dart/ Validate parameters for create Dart package
PackagesApi packagesValidateUploadDeb POST /packages/{owner}/{repo}/validate-upload/deb/ Validate parameters for create Debian package
PackagesApi packagesValidateUploadDocker POST /packages/{owner}/{repo}/validate-upload/docker/ Validate parameters for create Docker package
PackagesApi packagesValidateUploadGo POST /packages/{owner}/{repo}/validate-upload/go/ Validate parameters for create Go package
PackagesApi packagesValidateUploadHelm POST /packages/{owner}/{repo}/validate-upload/helm/ Validate parameters for create Helm package
PackagesApi packagesValidateUploadHex POST /packages/{owner}/{repo}/validate-upload/hex/ Validate parameters for create Hex package
PackagesApi packagesValidateUploadHuggingface POST /packages/{owner}/{repo}/validate-upload/huggingface/ Validate parameters for create HuggingFace package
PackagesApi packagesValidateUploadLuarocks POST /packages/{owner}/{repo}/validate-upload/luarocks/ Validate parameters for create LuaRocks package
PackagesApi packagesValidateUploadMaven POST /packages/{owner}/{repo}/validate-upload/maven/ Validate parameters for create Maven package
PackagesApi packagesValidateUploadNpm POST /packages/{owner}/{repo}/validate-upload/npm/ Validate parameters for create npm package
PackagesApi packagesValidateUploadNuget POST /packages/{owner}/{repo}/validate-upload/nuget/ Validate parameters for create NuGet package
PackagesApi packagesValidateUploadP2 POST /packages/{owner}/{repo}/validate-upload/p2/ Validate parameters for create P2 package
PackagesApi packagesValidateUploadPython POST /packages/{owner}/{repo}/validate-upload/python/ Validate parameters for create Python package
PackagesApi packagesValidateUploadRaw POST /packages/{owner}/{repo}/validate-upload/raw/ Validate parameters for create Raw package
PackagesApi packagesValidateUploadRpm POST /packages/{owner}/{repo}/validate-upload/rpm/ Validate parameters for create RedHat package
PackagesApi packagesValidateUploadRuby POST /packages/{owner}/{repo}/validate-upload/ruby/ Validate parameters for create Ruby package
PackagesApi packagesValidateUploadSwift POST /packages/{owner}/{repo}/validate-upload/swift/ Validate parameters for create Swift package
PackagesApi packagesValidateUploadTerraform POST /packages/{owner}/{repo}/validate-upload/terraform/ Validate parameters for create Terraform package
PackagesApi packagesValidateUploadVagrant POST /packages/{owner}/{repo}/validate-upload/vagrant/ Validate parameters for create Vagrant package
QuotaApi quotaHistoryRead GET /quota/history/{owner}/ Quota history for a given namespace.
QuotaApi quotaOssHistoryRead GET /quota/oss/history/{owner}/ Open-source Quota history for a given namespace.
QuotaApi quotaOssRead GET /quota/oss/{owner}/ Open-source Quota usage for a given namespace.
QuotaApi quotaRead GET /quota/{owner}/ Quota usage for a given namespace.
RatesApi ratesLimitsList GET /rates/limits/ Endpoint to check rate limits for current user.
ReposApi apiReposGeoipStatus GET /repos/{owner}/{identifier}/geoip/status/ Retrieve the GeoIP status for this repository.
ReposApi repoRetentionPartialUpdate PATCH /repos/{owner}/{repo}/retention/ Update the retention rules for the repository.
ReposApi repoRetentionRead GET /repos/{owner}/{repo}/retention/ Retrieve the retention rules for the repository.
ReposApi reposCreate POST /repos/{owner}/ Create a new repository in a given namespace.
ReposApi reposDelete DELETE /repos/{owner}/{identifier}/ Delete a repository in a given namespace.
ReposApi reposEcdsaCreate POST /repos/{owner}/{identifier}/ecdsa/ Set the active ECDSA key for the Repository.
ReposApi reposEcdsaList GET /repos/{owner}/{identifier}/ecdsa/ Retrieve the active ECDSA key for the Repository.
ReposApi reposEcdsaRegenerate POST /repos/{owner}/{identifier}/ecdsa/regenerate/ Regenerate ECDSA Key for the Repository.
ReposApi reposGeoipDisable POST /repos/{owner}/{identifier}/geoip/disable/ Disable GeoIP for this repository.
ReposApi reposGeoipEnable POST /repos/{owner}/{identifier}/geoip/enable/ Enable GeoIP for this repository.
ReposApi reposGeoipPartialUpdate PATCH /repos/{owner}/{identifier}/geoip Partially update repository geoip rules.
ReposApi reposGeoipRead GET /repos/{owner}/{identifier}/geoip List all repository geoip rules.
ReposApi reposGeoipTest POST /repos/{owner}/{identifier}/geoip/test/ Test a list of IP addresses against the repository's current GeoIP rules.
ReposApi reposGeoipUpdate PUT /repos/{owner}/{identifier}/geoip Replace repository geoip rules.
ReposApi reposGpgCreate POST /repos/{owner}/{identifier}/gpg/ Set the active GPG key for the Repository.
ReposApi reposGpgList GET /repos/{owner}/{identifier}/gpg/ Retrieve the active GPG key for the Repository.
ReposApi reposGpgRegenerate POST /repos/{owner}/{identifier}/gpg/regenerate/ Regenerate GPG Key for the Repository.
ReposApi reposNamespaceList GET /repos/{owner}/ Get a list of all repositories within a namespace.
ReposApi reposPartialUpdate PATCH /repos/{owner}/{identifier}/ Update details about a repository in a given namespace.
ReposApi reposPrivilegesList GET /repos/{owner}/{identifier}/privileges List all explicity created privileges for the repository.
ReposApi reposPrivilegesPartialUpdate PATCH /repos/{owner}/{identifier}/privileges Modify privileges for the repository.
ReposApi reposPrivilegesUpdate PUT /repos/{owner}/{identifier}/privileges Replace all existing repository privileges with those specified.
ReposApi reposRead GET /repos/{owner}/{identifier}/ Get a specific repository.
ReposApi reposRsaCreate POST /repos/{owner}/{identifier}/rsa/ Set the active RSA key for the Repository.
ReposApi reposRsaList GET /repos/{owner}/{identifier}/rsa/ Retrieve the active RSA key for the Repository.
ReposApi reposRsaRegenerate POST /repos/{owner}/{identifier}/rsa/regenerate/ Regenerate RSA Key for the Repository.
ReposApi reposTransferRegion POST /repos/{owner}/{repo}/transfer-region/ Transfer a repository to a different region.
ReposApi reposUpstreamCargoCreate POST /repos/{owner}/{identifier}/upstream/cargo/ Create a Cargo upstream config for this repository.
ReposApi reposUpstreamCargoDelete DELETE /repos/{owner}/{identifier}/upstream/cargo/{slug_perm}/ Delete a Cargo upstream config for this repository.
ReposApi reposUpstreamCargoList GET /repos/{owner}/{identifier}/upstream/cargo/ List Cargo upstream configs for this repository.
ReposApi reposUpstreamCargoPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/cargo/{slug_perm}/ Partially update a Cargo upstream config for this repository.
ReposApi reposUpstreamCargoRead GET /repos/{owner}/{identifier}/upstream/cargo/{slug_perm}/ Retrieve a Cargo upstream config for this repository.
ReposApi reposUpstreamCargoUpdate PUT /repos/{owner}/{identifier}/upstream/cargo/{slug_perm}/ Update a Cargo upstream config for this repository.
ReposApi reposUpstreamComposerCreate POST /repos/{owner}/{identifier}/upstream/composer/ Create a Composer upstream config for this repository.
ReposApi reposUpstreamComposerDelete DELETE /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/ Delete a Composer upstream config for this repository.
ReposApi reposUpstreamComposerList GET /repos/{owner}/{identifier}/upstream/composer/ List Composer upstream configs for this repository.
ReposApi reposUpstreamComposerPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/ Partially update a Composer upstream config for this repository.
ReposApi reposUpstreamComposerRead GET /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/ Retrieve a Composer upstream config for this repository.
ReposApi reposUpstreamComposerUpdate PUT /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/ Update a Composer upstream config for this repository.
ReposApi reposUpstreamCondaCreate POST /repos/{owner}/{identifier}/upstream/conda/ Create a Conda upstream config for this repository.
ReposApi reposUpstreamCondaDelete DELETE /repos/{owner}/{identifier}/upstream/conda/{slug_perm}/ Delete a Conda upstream config for this repository.
ReposApi reposUpstreamCondaList GET /repos/{owner}/{identifier}/upstream/conda/ List Conda upstream configs for this repository.
ReposApi reposUpstreamCondaPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/conda/{slug_perm}/ Partially update a Conda upstream config for this repository.
ReposApi reposUpstreamCondaRead GET /repos/{owner}/{identifier}/upstream/conda/{slug_perm}/ Retrieve a Conda upstream config for this repository.
ReposApi reposUpstreamCondaUpdate PUT /repos/{owner}/{identifier}/upstream/conda/{slug_perm}/ Update a Conda upstream config for this repository.
ReposApi reposUpstreamCranCreate POST /repos/{owner}/{identifier}/upstream/cran/ Create a CRAN upstream config for this repository.
ReposApi reposUpstreamCranDelete DELETE /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Delete a CRAN upstream config for this repository.
ReposApi reposUpstreamCranList GET /repos/{owner}/{identifier}/upstream/cran/ List CRAN upstream configs for this repository.
ReposApi reposUpstreamCranPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Partially update a CRAN upstream config for this repository.
ReposApi reposUpstreamCranRead GET /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Retrieve a CRAN upstream config for this repository.
ReposApi reposUpstreamCranUpdate PUT /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Update a CRAN upstream config for this repository.
ReposApi reposUpstreamDartCreate POST /repos/{owner}/{identifier}/upstream/dart/ Create a Dart upstream config for this repository.
ReposApi reposUpstreamDartDelete DELETE /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Delete a Dart upstream config for this repository.
ReposApi reposUpstreamDartList GET /repos/{owner}/{identifier}/upstream/dart/ List Dart upstream configs for this repository.
ReposApi reposUpstreamDartPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Partially update a Dart upstream config for this repository.
ReposApi reposUpstreamDartRead GET /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Retrieve a Dart upstream config for this repository.
ReposApi reposUpstreamDartUpdate PUT /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Update a Dart upstream config for this repository.
ReposApi reposUpstreamDebCreate POST /repos/{owner}/{identifier}/upstream/deb/ Create a Debian upstream config for this repository.
ReposApi reposUpstreamDebDelete DELETE /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Delete a Debian upstream config for this repository.
ReposApi reposUpstreamDebList GET /repos/{owner}/{identifier}/upstream/deb/ List Debian upstream configs for this repository.
ReposApi reposUpstreamDebPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Partially update a Debian upstream config for this repository.
ReposApi reposUpstreamDebRead GET /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Retrieve a Debian upstream config for this repository.
ReposApi reposUpstreamDebUpdate PUT /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Update a Debian upstream config for this repository.
ReposApi reposUpstreamDockerCreate POST /repos/{owner}/{identifier}/upstream/docker/ Create a Docker upstream config for this repository.
ReposApi reposUpstreamDockerDelete DELETE /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Delete a Docker upstream config for this repository.
ReposApi reposUpstreamDockerList GET /repos/{owner}/{identifier}/upstream/docker/ List Docker upstream configs for this repository.
ReposApi reposUpstreamDockerPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Partially update a Docker upstream config for this repository.
ReposApi reposUpstreamDockerRead GET /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Retrieve a Docker upstream config for this repository.
ReposApi reposUpstreamDockerUpdate PUT /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Update a Docker upstream config for this repository.
ReposApi reposUpstreamGoCreate POST /repos/{owner}/{identifier}/upstream/go/ Create a Go upstream config for this repository.
ReposApi reposUpstreamGoDelete DELETE /repos/{owner}/{identifier}/upstream/go/{slug_perm}/ Delete a Go upstream config for this repository.
ReposApi reposUpstreamGoList GET /repos/{owner}/{identifier}/upstream/go/ List Go upstream configs for this repository.
ReposApi reposUpstreamGoPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/go/{slug_perm}/ Partially update a Go upstream config for this repository.
ReposApi reposUpstreamGoRead GET /repos/{owner}/{identifier}/upstream/go/{slug_perm}/ Retrieve a Go upstream config for this repository.
ReposApi reposUpstreamGoUpdate PUT /repos/{owner}/{identifier}/upstream/go/{slug_perm}/ Update a Go upstream config for this repository.
ReposApi reposUpstreamHelmCreate POST /repos/{owner}/{identifier}/upstream/helm/ Create a Helm upstream config for this repository.
ReposApi reposUpstreamHelmDelete DELETE /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Delete a Helm upstream config for this repository.
ReposApi reposUpstreamHelmList GET /repos/{owner}/{identifier}/upstream/helm/ List Helm upstream configs for this repository.
ReposApi reposUpstreamHelmPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Partially update a Helm upstream config for this repository.
ReposApi reposUpstreamHelmRead GET /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Retrieve a Helm upstream config for this repository.
ReposApi reposUpstreamHelmUpdate PUT /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Update a Helm upstream config for this repository.
ReposApi reposUpstreamHexCreate POST /repos/{owner}/{identifier}/upstream/hex/ Create a Hex upstream config for this repository.
ReposApi reposUpstreamHexDelete DELETE /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/ Delete a Hex upstream config for this repository.
ReposApi reposUpstreamHexList GET /repos/{owner}/{identifier}/upstream/hex/ List Hex upstream configs for this repository.
ReposApi reposUpstreamHexPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/ Partially update a Hex upstream config for this repository.
ReposApi reposUpstreamHexRead GET /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/ Retrieve a Hex upstream config for this repository.
ReposApi reposUpstreamHexUpdate PUT /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/ Update a Hex upstream config for this repository.
ReposApi reposUpstreamHuggingfaceCreate POST /repos/{owner}/{identifier}/upstream/huggingface/ Create a HuggingFace upstream config for this repository.
ReposApi reposUpstreamHuggingfaceDelete DELETE /repos/{owner}/{identifier}/upstream/huggingface/{slug_perm}/ Delete a HuggingFace upstream config for this repository.
ReposApi reposUpstreamHuggingfaceList GET /repos/{owner}/{identifier}/upstream/huggingface/ List HuggingFace upstream configs for this repository.
ReposApi reposUpstreamHuggingfacePartialUpdate PATCH /repos/{owner}/{identifier}/upstream/huggingface/{slug_perm}/ Partially update a HuggingFace upstream config for this repository.
ReposApi reposUpstreamHuggingfaceRead GET /repos/{owner}/{identifier}/upstream/huggingface/{slug_perm}/ Retrieve a HuggingFace upstream config for this repository.
ReposApi reposUpstreamHuggingfaceUpdate PUT /repos/{owner}/{identifier}/upstream/huggingface/{slug_perm}/ Update a HuggingFace upstream config for this repository.
ReposApi reposUpstreamMavenCreate POST /repos/{owner}/{identifier}/upstream/maven/ Create a Maven upstream config for this repository.
ReposApi reposUpstreamMavenDelete DELETE /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Delete a Maven upstream config for this repository.
ReposApi reposUpstreamMavenList GET /repos/{owner}/{identifier}/upstream/maven/ List Maven upstream configs for this repository.
ReposApi reposUpstreamMavenPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Partially update a Maven upstream config for this repository.
ReposApi reposUpstreamMavenRead GET /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Retrieve a Maven upstream config for this repository.
ReposApi reposUpstreamMavenUpdate PUT /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Update a Maven upstream config for this repository.
ReposApi reposUpstreamNpmCreate POST /repos/{owner}/{identifier}/upstream/npm/ Create a npm upstream config for this repository.
ReposApi reposUpstreamNpmDelete DELETE /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Delete a npm upstream config for this repository.
ReposApi reposUpstreamNpmList GET /repos/{owner}/{identifier}/upstream/npm/ List npm upstream configs for this repository.
ReposApi reposUpstreamNpmPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Partially update a npm upstream config for this repository.
ReposApi reposUpstreamNpmRead GET /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Retrieve a npm upstream config for this repository.
ReposApi reposUpstreamNpmUpdate PUT /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Update a npm upstream config for this repository.
ReposApi reposUpstreamNugetCreate POST /repos/{owner}/{identifier}/upstream/nuget/ Create a NuGet upstream config for this repository.
ReposApi reposUpstreamNugetDelete DELETE /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Delete a NuGet upstream config for this repository.
ReposApi reposUpstreamNugetList GET /repos/{owner}/{identifier}/upstream/nuget/ List NuGet upstream configs for this repository.
ReposApi reposUpstreamNugetPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Partially update a NuGet upstream config for this repository.
ReposApi reposUpstreamNugetRead GET /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Retrieve a NuGet upstream config for this repository.
ReposApi reposUpstreamNugetUpdate PUT /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Update a NuGet upstream config for this repository.
ReposApi reposUpstreamPythonCreate POST /repos/{owner}/{identifier}/upstream/python/ Create a Python upstream config for this repository.
ReposApi reposUpstreamPythonDelete DELETE /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Delete a Python upstream config for this repository.
ReposApi reposUpstreamPythonList GET /repos/{owner}/{identifier}/upstream/python/ List Python upstream configs for this repository.
ReposApi reposUpstreamPythonPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Partially update a Python upstream config for this repository.
ReposApi reposUpstreamPythonRead GET /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Retrieve a Python upstream config for this repository.
ReposApi reposUpstreamPythonUpdate PUT /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Update a Python upstream config for this repository.
ReposApi reposUpstreamRpmCreate POST /repos/{owner}/{identifier}/upstream/rpm/ Create a RedHat upstream config for this repository.
ReposApi reposUpstreamRpmDelete DELETE /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Delete a RedHat upstream config for this repository.
ReposApi reposUpstreamRpmList GET /repos/{owner}/{identifier}/upstream/rpm/ List RedHat upstream configs for this repository.
ReposApi reposUpstreamRpmPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Partially update a RedHat upstream config for this repository.
ReposApi reposUpstreamRpmRead GET /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Retrieve a RedHat upstream config for this repository.
ReposApi reposUpstreamRpmUpdate PUT /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Update a RedHat upstream config for this repository.
ReposApi reposUpstreamRubyCreate POST /repos/{owner}/{identifier}/upstream/ruby/ Create a Ruby upstream config for this repository.
ReposApi reposUpstreamRubyDelete DELETE /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Delete a Ruby upstream config for this repository.
ReposApi reposUpstreamRubyList GET /repos/{owner}/{identifier}/upstream/ruby/ List Ruby upstream configs for this repository.
ReposApi reposUpstreamRubyPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Partially update a Ruby upstream config for this repository.
ReposApi reposUpstreamRubyRead GET /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Retrieve a Ruby upstream config for this repository.
ReposApi reposUpstreamRubyUpdate PUT /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Update a Ruby upstream config for this repository.
ReposApi reposUpstreamSwiftCreate POST /repos/{owner}/{identifier}/upstream/swift/ Create a Swift upstream config for this repository.
ReposApi reposUpstreamSwiftDelete DELETE /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Delete a Swift upstream config for this repository.
ReposApi reposUpstreamSwiftList GET /repos/{owner}/{identifier}/upstream/swift/ List Swift upstream configs for this repository.
ReposApi reposUpstreamSwiftPartialUpdate PATCH /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Partially update a Swift upstream config for this repository.
ReposApi reposUpstreamSwiftRead GET /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Retrieve a Swift upstream config for this repository.
ReposApi reposUpstreamSwiftUpdate PUT /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Update a Swift upstream config for this repository.
ReposApi reposUserList GET /repos/ Get a list of all repositories associated with current user.
ReposApi reposX509EcdsaList GET /repos/{owner}/{identifier}/x509-ecdsa/ Retrieve the active X.509 ECDSA certificate for the Repository.
ReposApi reposX509RsaList GET /repos/{owner}/{identifier}/x509-rsa/ Retrieve the active X.509 RSA certificate for the Repository.
StatusApi statusCheckBasic GET /status/check/basic/ Endpoint to check basic API connectivity.
StorageRegionsApi storageRegionsList GET /storage-regions/ Get a list of all available storage regions.
StorageRegionsApi storageRegionsRead GET /storage-regions/{slug}/ Get a specific storage region.
UserApi userSelf GET /user/self/ Provide a brief for the current user (if any).
UserApi userTokenCreate POST /user/token/ Create or retrieve API token for a user.
UserApi userTokensCreate POST /user/tokens/ Create an API key for the user that is currently authenticated.
UserApi userTokensList GET /user/tokens/ Retrieve the API key assigned to the user that is currently authenticated.
UserApi userTokensRefresh PUT /user/tokens/{slug_perm}/refresh/ Refresh the specified API key for the user that is currently authenticated.
UsersApi usersProfileRead GET /users/profile/{slug}/ Provide a brief for the specified user (if any).
VulnerabilitiesApi vulnerabilitiesNamespaceList GET /vulnerabilities/{owner}/ Lists scan results for a specific namespace.
VulnerabilitiesApi vulnerabilitiesPackageList GET /vulnerabilities/{owner}/{repo}/{package}/ Lists scan results for a specific package.
VulnerabilitiesApi vulnerabilitiesRead GET /vulnerabilities/{owner}/{repo}/{package}/{identifier}/ Get a scan result.
VulnerabilitiesApi vulnerabilitiesRepoList GET /vulnerabilities/{owner}/{repo}/ Lists scan results for a specific repository.
WebhooksApi webhooksCreate POST /webhooks/{owner}/{repo}/ Create a specific webhook in a repository.
WebhooksApi webhooksDelete DELETE /webhooks/{owner}/{repo}/{identifier}/ Delete a specific webhook in a repository.
WebhooksApi webhooksList GET /webhooks/{owner}/{repo}/ Get a list of all webhooks in a repository.
WebhooksApi webhooksPartialUpdate PATCH /webhooks/{owner}/{repo}/{identifier}/ Update a specific webhook in a repository.
WebhooksApi webhooksRead GET /webhooks/{owner}/{repo}/{identifier}/ Views for working with repository webhooks.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apikey

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

basic

  • Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@cloudsmith.io