Repos

cdn_url

string | null

optional

Base URL from which packages and other artifacts are downloaded.

content_kind

string

optional

Allowed values: Standard, Distribution, Upstream
Defaults to Standard

The repository content kind determines whether this repository contains packages, or provides a distribution of packages from other repositories. You can only select the content kind at repository creation time.

contextual_auth_realm

boolean

optional

If checked, missing credentials for this repository where basic authentication is required shall present an enriched value in the 'WWW-Authenticate' header containing the namespace and repository. This can be useful for tooling such as SBT where the authentication realm is used to distinguish and disambiguate credentials.

copy_own

boolean

optional

If checked, users can copy any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org.

copy_packages

string

optional

Allowed values: Admin, Write, Read
Defaults to Read

This defines the minimum level of privilege required for a user to copy packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific copy setting.

cosign_signing_enabled

boolean

optional

When enabled, all pushed (or pulled from upstream) OCI packages and artifacts will be signed using cosign with the repository's ECDSA key. This generates a distinct cosign signature artifact per artifact.

created_at

date-time

optional

default_privilege

string

optional

Allowed values: Admin, Write, Read, None
Defaults to None

This defines the default level of privilege that all of your organization members have for this repository. This does not include collaborators, but applies to any member of the org regardless of their own membership role (i.e. it applies to owners, managers and members). Be careful if setting this to admin, because any member will be able to change settings.

delete_own

boolean

optional

If checked, users can delete any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org.

delete_packages

string

optional

Allowed values: Admin, Write
Defaults to Admin

This defines the minimum level of privilege required for a user to delete packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific delete setting.

deleted_at

date-time | null

optional

The datetime the repository was manually deleted at.

description

string

optional

A description of the repository's purpose/contents.

distributes

array of strings

optional

Items must be unique

The repositories distributed through this repo. Adding repos here is only valid if the content_kind is DISTRIBUTION.

string

docker_refresh_tokens_enabled

boolean

optional

If checked, refresh tokens will be issued in addition to access tokens for Docker authentication. This allows unlimited extension of the lifetime of access tokens.

ecdsa_keys

array of objects

optional

array of objects

object

active

boolean

optional

created_at

date-time

optional

default

boolean

optional

fingerprint

string

optional

length ≥ 1

fingerprint_short

string

optional

public_key

string

optional

length ≥ 1

ssh_fingerprint

string | null

optional

enforce_eula

boolean

optional

If checked, downloads will explicitly require acceptance of an EULA.

gpg_keys

array of objects

optional

array of objects

object

active

boolean

optional

comment

string

required

length ≥ 1

created_at

date-time

optional

default

boolean

optional

fingerprint

string

optional

length ≥ 1

fingerprint_short

string

optional

public_key

string

optional

length ≥ 1

index_files

boolean

optional

If checked, files contained in packages will be indexed, which increase the synchronisation time required for packages. Note that it is recommended you keep this enabled unless the synchronisation time is significantly impacted.

is_open_source

boolean

optional

is_private

boolean

optional

is_public

boolean

optional

manage_entitlements_privilege

string

optional

Allowed values: Admin, Write, Read
Defaults to Admin

This defines the minimum level of privilege required for a user to manage entitlement tokens with private repositories. Management is the ability to create, alter, enable, disable or delete all tokens without a repository.

move_own

boolean

optional

If checked, users can move any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org.

move_packages

string

optional

Allowed values: Admin, Write, Read
Defaults to Admin

This defines the minimum level of privilege required for a user to move packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific move setting.

name

string

required

^\w[\w \-'\.\/()]+$
length between 1 and 50

A descriptive name for the repository.

namespace

slug

optional

^[-a-zA-Z0-9_]+$

Namespace to which this repository belongs.

namespace_url

uri

optional

API endpoint where data about this namespace can be retrieved.

nuget_native_signing_enabled

boolean

optional

When enabled, all pushed (or pulled from upstream) nuget packages and artifacts will be signed using the repository's X.509 RSA certificate. Additionally, the nuget RepositorySignature index will list all of the repository's signing certificates including the ones from configured upstreams.

num_downloads

integer

optional

The number of downloads for packages in the repository.

num_policy_violated_packages

integer

optional

Number of packages with policy violations in a repository.

num_quarantined_packages

integer

optional

Number of quarantined packages in a repository.

open_source_license

string | null

optional

The SPDX identifier of the open source license.

open_source_project_url

uri | null

optional

length ≤ 200

The URL to the Open-Source project, used for validating that the project meets the requirements for Open-Source.

package_count

integer

optional

The number of packages in the repository.

package_group_count

integer

optional

The number of groups in the repository.

proxy_npmjs

boolean

optional

If checked, Npm packages that are not in the repository when requested by clients will automatically be proxied from the public npmjs.org registry. If there is at least one version for a package, others will not be proxied.

proxy_pypi

boolean

optional

If checked, Python packages that are not in the repository when requested by clients will automatically be proxied from the public pypi.python.org registry. If there is at least one version for a package, others will not be proxied.

raw_package_index_enabled

boolean

optional

If checked, HTML and JSON indexes will be generated that list all available raw packages in the repository.

raw_package_index_signatures_enabled

boolean

optional

If checked, the HTML and JSON indexes will display raw package GPG signatures alongside the index packages.

replace_packages

string

optional

Allowed values: Admin, Write
Defaults to Write

This defines the minimum level of privilege required for a user to republish packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific republish setting. Please note that the user still requires the privilege to delete packages that will be replaced by the new package; otherwise the republish will fail.

replace_packages_by_default

boolean

optional

If checked, uploaded packages will overwrite/replace any others with the same attributes (e.g. same version) by default. This only applies if the user has the required privilege for the republishing AND has the required privilege to delete existing packages that they don't own.

repository_type

integer

optional

Allowed values: 1, 2, 3

The repository type changes how it is accessed and billed. Private repositories are visible only to you or authorized delegates. Open-Source repositories are always visible to everyone and are restricted by licensing, but are free to use and come with generous bandwidth/storage. You can only select Open-Source at repository creation time.

repository_type_str

string

optional

Allowed values: Public, Private, Open-Source
Defaults to Public

The repository type changes how it is accessed and billed. Private repositories are visible only to you or authorized delegates. Public repositories are visible to all Cloudsmith users.

resync_own

boolean

optional

If checked, users can resync any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org.

resync_packages

string

optional

Allowed values: Admin, Write
Defaults to Admin

This defines the minimum level of privilege required for a user to resync packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific resync setting.

scan_own

boolean

optional

If checked, users can scan any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org.

scan_packages

string

optional

Allowed values: Admin, Write, Read
Defaults to Read

This defines the minimum level of privilege required for a user to scan packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific scan setting.

self_html_url

string

optional

length ≥ 1

Website URL for this repository.

self_url

uri

optional

API endpoint where data about this repository can be retrieved.

show_setup_all

boolean

optional

If checked, the Set Me Up help for all formats will always be shown, even if you don't have packages of that type uploaded. Otherwise, help will only be shown for packages that are in the repository. For example, if you have uploaded only NuGet packages, then the Set Me Up help for NuGet packages will be shown only.

size

integer

optional

The calculated size of the repository.

size_str

string

optional

The calculated size of the repository (human readable).

slug

string

optional

The slug identifies the repository in URIs.

slug_perm

slug

optional

^[-a-zA-Z0-9_]+$
length ≥ 1

The slug_perm immutably identifies the repository. It will never change once a repository has been created.

storage_region

string

optional

Defaults to default

The Cloudsmith region in which package files are stored.

strict_npm_validation

boolean

optional

If checked, npm packages will be validated strictly to ensure the package matches specifcation. You can turn this on if you want to guarantee that the packages will work with npm-cli and other tools correctly.

tag_pre_releases_as_latest

boolean

optional

If checked, packages pushed with a pre-release component on that version will be marked with the 'latest' tag. Note that if unchecked, a repository containing ONLY pre-release versions, will have no version marked latest which may cause incompatibility with native tools

use_debian_labels

boolean

optional

If checked, a 'Label' field will be present in Debian-based repositories. It will contain a string that identifies the entitlement token used to authenticate the repository, in the form of 'source=t-<identifier>'; or 'source=none' if no token was used. You can use this to help with pinning.

use_default_cargo_upstream

boolean

optional

If checked, dependencies of uploaded Cargo crates which do not set an explicit value for "registry" will be assumed to be available from crates.io. If unchecked, dependencies with unspecified "registry" values will be assumed to be available in the registry being uploaded to. Uncheck this if you want to ensure that dependencies are only ever installed from Cloudsmith unless explicitly specified as belong to another registry.

use_entitlements_privilege

string

optional

Allowed values: Admin, Write, Read
Defaults to Read

This defines the minimum level of privilege required for a user to see/use entitlement tokens with private repositories. If a user does not have the permission, they will only be able to download packages using other credentials, such as email/password via basic authentication. Use this if you want to force users to only use their user-based token, which is tied to their access (if removed, they can't use it).

use_noarch_packages

boolean

optional

If checked, noarch packages (if supported) are enabled in installations/configurations. A noarch package is one that is not tied to specific system architecture (like i686).

use_source_packages

boolean

optional

If checked, source packages (if supported) are enabled in installations/configurations. A source package is one that contains source code rather than built binaries.

use_vulnerability_scanning

boolean

optional

If checked, vulnerability scanning will be enabled for all supported packages within this repository.

user_entitlements_enabled

boolean

optional

If checked, users can use and manage their own user-specific entitlement token for the repository (if private). Otherwise, user-specific entitlements are disabled for all users.

view_statistics

string

optional

Allowed values: Admin, Write, Read
Defaults to Read

This defines the minimum level of privilege required for a user to view repository statistics, to include entitlement-based usage, if applicable. If a user does not have the permission, they won't be able to view any statistics, either via the UI, API or CLI.

Repos Partial Update

Request

Response