CloudsmithApi::ReposApi

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

Method	HTTP request	Description
repos_create	POST /repos/owner/	Create a new repository in a given namespace.
repos_delete	DELETE /repos/owner/identifier/	Delete a repository in a given namespace.
repos_geoip_disable	POST /repos/owner/identifier/geoip/disable/	Disable GeoIP for this repository.
repos_geoip_enable	POST /repos/owner/identifier/geoip/enable/	Enable GeoIP for this repository.
repos_geoip_read	GET /repos/owner/identifier/geoip	List all created GeoIP rules for the repository.
repos_gpg_create	POST /repos/owner/identifier/gpg/	Set the active GPG key for the Repository.
repos_gpg_list	GET /repos/owner/identifier/gpg/	Retrieve the active GPG key for the Repository.
repos_gpg_regenerate	POST /repos/owner/identifier/gpg/regenerate/	Regenerate GPG Key for the Repository.
repos_namespace_list	GET /repos/owner/	Get a list of all repositories within a namespace.
repos_partial_update	PATCH /repos/owner/identifier/	Update details about a repository in a given namespace.
repos_privileges_list	GET /repos/owner/identifier/privileges	List all explicity created privileges for the repository.
repos_privileges_partial_update	PATCH /repos/owner/identifier/privileges	Modify privileges for the repository.
repos_privileges_update	PUT /repos/owner/identifier/privileges	Replace all existing repository privileges with those specified.
repos_read	GET /repos/owner/identifier/	Get a specific repository.
repos_rsa_create	POST /repos/owner/identifier/rsa/	Set the active RSA key for the Repository.
repos_rsa_list	GET /repos/owner/identifier/rsa/	Retrieve the active RSA key for the Repository.
repos_rsa_regenerate	POST /repos/owner/identifier/rsa/regenerate/	Regenerate RSA Key for the Repository.
repos_user_list	GET /repos/	Get a list of all repositories associated with current user.

repos_create

RepositoryCreate repos_create(owner, opts)

Create a new repository in a given namespace.

Create a new repository in a given namespace.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

opts = { 
  data: CloudsmithApi::RepositoryCreateRequest.new # RepositoryCreateRequest | 
}

begin
  #Create a new repository in a given namespace.
  result = api_instance.repos_create(owner, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_create: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
data	RepositoryCreateRequest		[optional]

Return type

RepositoryCreate

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_delete

repos_delete(owner, identifier)

Delete a repository in a given namespace.

Delete a repository in a given namespace.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #Delete a repository in a given namespace.
  api_instance.repos_delete(owner, identifier)
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

nil (empty response body)

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_geoip_disable

repos_geoip_disable(owner, identifier, opts)

Disable GeoIP for this repository.

Disable GeoIP for this repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RespositoryGeoIPEnableDisableRequest.new # RespositoryGeoIPEnableDisableRequest | 
}

begin
  #Disable GeoIP for this repository.
  api_instance.repos_geoip_disable(owner, identifier, opts)
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_geoip_disable: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RespositoryGeoIPEnableDisableRequest		[optional]

Return type

nil (empty response body)

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_geoip_enable

repos_geoip_enable(owner, identifier, opts)

Enable GeoIP for this repository.

Enable GeoIP for this repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RespositoryGeoIPEnableDisableRequest.new # RespositoryGeoIPEnableDisableRequest | 
}

begin
  #Enable GeoIP for this repository.
  api_instance.repos_geoip_enable(owner, identifier, opts)
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_geoip_enable: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RespositoryGeoIPEnableDisableRequest		[optional]

Return type

nil (empty response body)

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_geoip_read

InlineResponse200 repos_geoip_read(owner, identifier)

List all created GeoIP rules for the repository.

List all created GeoIP rules for the repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #List all created GeoIP rules for the repository.
  result = api_instance.repos_geoip_read(owner, identifier)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_geoip_read: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

InlineResponse200

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_gpg_create

RepositoryGpgKey repos_gpg_create(owner, identifier, opts)

Set the active GPG key for the Repository.

Set the active GPG key for the Repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RepositoryGpgKeyCreate.new # RepositoryGpgKeyCreate | 
}

begin
  #Set the active GPG key for the Repository.
  result = api_instance.repos_gpg_create(owner, identifier, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_gpg_create: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RepositoryGpgKeyCreate		[optional]

Return type

RepositoryGpgKey

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_gpg_list

RepositoryGpgKey repos_gpg_list(owner, identifier)

Retrieve the active GPG key for the Repository.

Retrieve the active GPG key for the Repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #Retrieve the active GPG key for the Repository.
  result = api_instance.repos_gpg_list(owner, identifier)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_gpg_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

RepositoryGpgKey

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_gpg_regenerate

RepositoryGpgKey repos_gpg_regenerate(owner, identifier)

Regenerate GPG Key for the Repository.

Regenerate GPG Key for the Repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #Regenerate GPG Key for the Repository.
  result = api_instance.repos_gpg_regenerate(owner, identifier)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_gpg_regenerate: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

RepositoryGpgKey

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_namespace_list

Array<Repository> repos_namespace_list(owner, opts)

Get a list of all repositories within a namespace.

Get a list of all repositories within a namespace.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

opts = { 
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #Get a list of all repositories within a namespace.
  result = api_instance.repos_namespace_list(owner, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_namespace_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
page	Integer	A page number within the paginated result set.	[optional]
page_size	Integer	Number of results to return per page.	[optional]

Return type

Array<Repository>

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_partial_update

Repository repos_partial_update(owner, identifier, opts)

Update details about a repository in a given namespace.

Update details about a repository in a given namespace.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RepositoryRequestPatch.new # RepositoryRequestPatch | 
}

begin
  #Update details about a repository in a given namespace.
  result = api_instance.repos_partial_update(owner, identifier, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_partial_update: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RepositoryRequestPatch		[optional]

Return type

Repository

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_privileges_list

RepositoryPrivilegeInput repos_privileges_list(owner, identifier, opts)

List all explicity created privileges for the repository.

List all explicity created privileges for the repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #List all explicity created privileges for the repository.
  result = api_instance.repos_privileges_list(owner, identifier, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_privileges_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
page	Integer	A page number within the paginated result set.	[optional]
page_size	Integer	Number of results to return per page.	[optional]

Return type

RepositoryPrivilegeInput

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_privileges_partial_update

repos_privileges_partial_update(owner, identifier, opts)

Modify privileges for the repository.

Modify privileges for the repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RepositoryPrivilegeInputRequestPatch.new # RepositoryPrivilegeInputRequestPatch | 
}

begin
  #Modify privileges for the repository.
  api_instance.repos_privileges_partial_update(owner, identifier, opts)
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_privileges_partial_update: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RepositoryPrivilegeInputRequestPatch		[optional]

Return type

nil (empty response body)

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_privileges_update

repos_privileges_update(owner, identifier, opts)

Replace all existing repository privileges with those specified.

Replace all existing repository privileges with those specified.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RepositoryPrivilegeInputRequest.new # RepositoryPrivilegeInputRequest | 
}

begin
  #Replace all existing repository privileges with those specified.
  api_instance.repos_privileges_update(owner, identifier, opts)
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_privileges_update: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RepositoryPrivilegeInputRequest		[optional]

Return type

nil (empty response body)

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_read

Repository repos_read(owner, identifier)

Get a specific repository.

Get a specific repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #Get a specific repository.
  result = api_instance.repos_read(owner, identifier)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_read: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

Repository

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_rsa_create

RepositoryRsaKey repos_rsa_create(owner, identifier, opts)

Set the active RSA key for the Repository.

Set the active RSA key for the Repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 

opts = { 
  data: CloudsmithApi::RepositoryRsaKeyCreate.new # RepositoryRsaKeyCreate | 
}

begin
  #Set the active RSA key for the Repository.
  result = api_instance.repos_rsa_create(owner, identifier, opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_rsa_create: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String
data	RepositoryRsaKeyCreate		[optional]

Return type

RepositoryRsaKey

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_rsa_list

RepositoryRsaKey repos_rsa_list(owner, identifier)

Retrieve the active RSA key for the Repository.

Retrieve the active RSA key for the Repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #Retrieve the active RSA key for the Repository.
  result = api_instance.repos_rsa_list(owner, identifier)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_rsa_list: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

RepositoryRsaKey

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_rsa_regenerate

RepositoryRsaKey repos_rsa_regenerate(owner, identifier)

Regenerate RSA Key for the Repository.

Regenerate RSA Key for the Repository.

Example

# 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::ReposApi.new

owner = 'owner_example' # String | 

identifier = 'identifier_example' # String | 


begin
  #Regenerate RSA Key for the Repository.
  result = api_instance.repos_rsa_regenerate(owner, identifier)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_rsa_regenerate: #{e}"
end

Parameters

Name	Type	Description	Notes
owner	String
identifier	String

Return type

RepositoryRsaKey

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

repos_user_list

Array<Repository> repos_user_list(opts)

Get a list of all repositories associated with current user.

Get a list of all repositories associated with current user.

Example

# 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::ReposApi.new

opts = { 
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #Get a list of all repositories associated with current user.
  result = api_instance.repos_user_list(opts)
  p result
rescue CloudsmithApi::ApiError => e
  puts "Exception when calling ReposApi->repos_user_list: #{e}"
end

Parameters

Name	Type	Description	Notes
page	Integer	A page number within the paginated result set.	[optional]
page_size	Integer	Number of results to return per page.	[optional]

Return type

Array<Repository>

Authorization

apikey

HTTP request headers

• Content-Type: application/json
• Accept: application/json