API Reference
Open Cloudsmith
DocumentationGuidesAPI Reference
  • General
    • Introduction
    • Rate Limits
    • Error Handling
  • API
    • Collapse icon
      Audit Log
      • Namespace List
        get
      • Repo List
        get
    • Collapse icon
      Broadcasts
      • Create Broadcast Token
        post
    • Collapse icon
      Deny Policy
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Distros
      • List
        get
      • Read
        get
    • Collapse icon
      Entitlements
      • Create
        post
      • Delete
        delete
      • Disable
        post
      • Enable
        post
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Refresh
        post
      • Reset
        post
      • Sync
        post
    • Collapse icon
      Files
      • Abort
        post
      • Complete
        post
      • Create
        post
      • Info
        get
      • Validate
        post
    • Collapse icon
      Formats
      • List
        get
      • Read
        get
    • Collapse icon
      Invites
      • Create
        post
      • Delete
        delete
      • Extend
        post
      • List
        get
      • Partial Update
        patch
      • Resend
        post
    • Collapse icon
      License Policy
      • Collapse icon
        Evaluation
        • Create
          post
        • List
          get
        • Read
          get
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Members
      • Collapse icon
        Update
        • Role
          patch
        • Visibility
          patch
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Refresh
        post
      • Remove
        get
    • Collapse icon
      Metrics
      • Collapse icon
        Entitlements
        • Account List
          get
        • Repo List
          get
      • Packages List
        get
    • Collapse icon
      Namespaces
      • List
        get
      • Read
        get
    • Collapse icon
      Openid Connect
      • Collapse icon
        Dynamic Mappings
        • List
          get
        • Read
          get
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Orgs
      • Delete
        delete
      • List
        get
      • Read
        get
    • Expand icon
      Packages
      • Collapse icon
        Upload
        • Alpine
          post
        • Cargo
          post
        • Cocoapods
          post
        • Composer
          post
        • Conan
          post
        • Conda
          post
        • Cran
          post
        • Dart
          post
        • Deb
          post
        • Docker
          post
        • Go
          post
        • Helm
          post
        • Hex
          post
        • Huggingface
          post
        • Luarocks
          post
        • Maven
          post
        • Npm
          post
        • Nuget
          post
        • P2
          post
        • Python
          post
        • Raw
          post
        • Rpm
          post
        • Ruby
          post
        • Swift
          post
        • Terraform
          post
        • Vagrant
          post
      • Collapse icon
        Validate Upload
        • Alpine
          post
        • Cargo
          post
        • Cocoapods
          post
        • Composer
          post
        • Conan
          post
        • Conda
          post
        • Cran
          post
        • Dart
          post
        • Deb
          post
        • Docker
          post
        • Go
          post
        • Helm
          post
        • Hex
          post
        • Huggingface
          post
        • Luarocks
          post
        • Maven
          post
        • Npm
          post
        • Nuget
          post
        • P2
          post
        • Python
          post
        • Raw
          post
        • Rpm
          post
        • Ruby
          post
        • Swift
          post
        • Terraform
          post
        • Vagrant
          post
      • Copy
        post
      • Delete
        delete
      • Dependencies
        get
      • Groups List
        get
      • List
        get
      • Move
        post
      • Quarantine
        post
      • Read
        get
      • Resync
        post
      • Scan
        post
      • Status
        get
      • Tag
        post
      • Update License
        patch
      • Vulnerabilities Osv List
        get
    • Collapse icon
      Quota
      • Collapse icon
        Oss
        • History Read
          get
        • Read
          get
      • History Read
        get
      • Read
        get
    • Collapse icon
      Repo Retention
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      Repos
      • Collapse icon
        Ecdsa
        • Create
          post
        • List
          get
        • Regenerate
          post
      • Collapse icon
        Geoip
        • Disable
          post
        • Enable
          post
        • Partial Update
          patch
        • Read
          get
        • Test
          post
        • Update
          put
      • Collapse icon
        Gpg
        • Create
          post
        • List
          get
        • Regenerate
          post
      • Collapse icon
        Privileges
        • List
          get
        • Partial Update
          patch
        • Update
          put
      • Collapse icon
        Rsa
        • Create
          post
        • List
          get
        • Regenerate
          post
      • Upstream
        • Collapse icon
          Cargo
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Composer
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Conda
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Cran
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Dart
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Deb
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Docker
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Go
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Helm
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Hex
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Huggingface
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Maven
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Npm
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Nuget
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Python
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Rpm
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Ruby
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
        • Collapse icon
          Swift
          • Create
            post
          • Delete
            delete
          • List
            get
          • Partial Update
            patch
          • Read
            get
          • Update
            put
      • Collapse icon
        X509
        • Ecdsa List
          get
        • Rsa List
          get
      • Create
        post
      • Delete
        delete
      • Namespace List
        get
      • Partial Update
        patch
      • Read
        get
      • Transfer Region
        post
      • User List
        get
    • Collapse icon
      Saml Authentication
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      Saml Group Sync
      • Create
        post
      • Delete
        delete
      • Disable
        post
      • Enable
        post
      • List
        get
      • Status
        get
    • Collapse icon
      Services
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Refresh
        post
    • Collapse icon
      Storage Regions
      • List
        get
      • Read
        get
    • Collapse icon
      Teams
      • Collapse icon
        Members
        • Create
          post
        • List
          get
        • Update
          put
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      User
      • Collapse icon
        Tokens
        • Create
          post
        • List
          get
        • Refresh
          put
      • Self
        get
      • Token Create
        post
    • Collapse icon
      Vulnerabilities
      • Namespace List
        get
      • Package List
        get
      • Read
        get
      • Repo List
        get
    • Collapse icon
      Vulnerability Policy
      • Collapse icon
        Evaluation
        • Create
          post
        • List
          get
        • Read
          get
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
      • Update
        put
    • Collapse icon
      Webhooks
      • Create
        post
      • Delete
        delete
      • List
        get
      • Partial Update
        patch
      • Read
        get
    • Collapse icon
      Workspaces Policies
      • Collapse icon
        Actions
        • Create
          post
        • Destroy
          delete
        • List
          get
        • Partial Update
          patch
        • Retrieve
          get
        • Update
          put
      • Create
        post
      • Decision Logs List
        get
      • Destroy
        delete
      • List
        get
      • Partial Update
        patch
      • Retrieve
        get
      • Simulate List
        get
      • Update
        put
    • Api Repos Geoip Status
      get
    • Badges Version List
      get
    • License Policy Violation List
      get
    • Rates Limits List
      get
    • Status Check Basic
      get
    • Users Profile Read
      get
    • Vulnerability Policy Violation List
      get

Packages

Packages Copy

Copy a package to another repository.

Request

posthttps://api.cloudsmith.io/v1/packages/{owner}/{repo}/{identifier}/copy
Body params optional

Response body

object

object

destination
string
required
length ≥ 1
republish
boolean
optional

If true, the package will overwrite any others with the same attributes (e.g. same version); otherwise, it will be flagged as a duplicate.

Response

Responses

Copied specified package to destination repository.

object

object

architectures
array of objects
optional

array of objects

object

description
string | null
optional
length ≤ 64
name
string
required
length between 1 and 128
cdn_url
string | null
optional
checksum_md5
string
optional
checksum_sha1
string
optional
checksum_sha256
string
optional
checksum_sha512
string
optional
dependencies_checksum_md5
string | null
optional

A checksum of all of the package's dependencies.

dependencies_url
uri
optional
description
string | null
optional

A textual description of this package.

display_name
string
optional
distro
object | null
optional

The distributions supported by this package format

object

name
string
required
length between 1 and 32
self_url
uri
optional
slug
string
optional
length ≥ 1

The slug identifier for this distribution

variants
string | null
optional
length ≤ 128
distro_version
object
optional

A list of the versions for this distribution

object

name
string
optional
length ≤ 64

The textual name for this version.

slug
string
optional
length ≥ 1

The slug identifier for this version

downloads
integer
optional
epoch
integer | null
optional

The epoch of the package version (if any).

extension
string
optional
filename
string
optional
length ≥ 1
files
array of objects
optional

array of objects

object

cdn_url
string | null
optional
checksum_md5
string | null
optional
checksum_sha1
string | null
optional
checksum_sha256
string | null
optional
checksum_sha512
string | null
optional
downloads
integer
optional
filename
string
optional
length ≥ 1
is_downloadable
boolean
optional
is_primary
boolean
optional
is_synchronised
boolean
optional
signature_url
string | null
optional
size
integer
optional

The calculated size of the file.

slug_perm
slug
optional
^[-a-zA-Z0-9_]+$
length ≥ 1
tag
string | null
optional

Freeform descriptor that describes what the file is.

format
string
optional
length ≥ 1
format_url
uri
optional
freeable_storage
integer
optional

Amount of storage that will be freed if this package is deleted

fully_qualified_name
string | null
optional
length ≥ 1
identifier_perm
string
optional
length ≥ 1

Unique and permanent identifier for the package.

identifiers
object
optional

Return a map of identifier field names and their values.

object

indexed
boolean
optional
is_cancellable
boolean
optional
is_copyable
boolean
optional
is_deleteable
boolean
optional
is_downloadable
boolean
optional
is_moveable
boolean
optional
is_quarantinable
boolean
optional
is_quarantined
boolean
optional
is_resyncable
boolean
optional
is_security_scannable
boolean
optional
is_sync_awaiting
boolean
optional
is_sync_completed
boolean
optional
is_sync_failed
boolean
optional
is_sync_in_flight
boolean
optional
is_sync_in_progress
boolean
optional
license
string | null
optional

The license of this package.

name
string | null
optional

The name of this package.

namespace
string
optional
length ≥ 1
namespace_url
uri
optional
num_files
integer
optional
origin_repository
string
optional
length ≥ 1
origin_repository_url
uri
optional
package_type
integer
optional
Allowed values: 1, 2, 3, 9

The type of package contents.

policy_violated
boolean
optional

Whether or not the package has violated any policy.

raw_license
string | null
optional
length ≥ 1

The raw license string.

release
string | null
optional

The release of the package version (if any).

repository
string
optional
length ≥ 1

The repository the package will be copied to.

repository_url
uri
optional
security_scan_completed_at
date-time | null
optional

The datetime the security scanning was completed.

security_scan_started_at
date-time | null
optional

The datetime the security scanning was started.

security_scan_status
string | null
optional
Allowed values: Awaiting Security Scan, Security Scanning in Progress, Scan Detected Vulnerabilities, Scan Detected No Vulnerabilities, Security Scanning Disabled, Security Scanning Failed, Security Scanning Skipped, Security Scanning Not Supported
Defaults to Awaiting Security Scan
security_scan_status_updated_at
date-time | null
optional

The datetime the security scanning status was updated.

self_html_url
string
optional
length ≥ 1
self_url
uri
optional
signature_url
string | null
optional
size
integer
optional

The calculated size of the package.

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

The public unique identifier for the package.

slug_perm
slug
optional
^[-a-zA-Z0-9_]+$
length ≥ 1
spdx_license
string | null
optional
length ≥ 1

The SPDX license identifier for this package.

stage
integer
optional
Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

The synchronisation (in progress) stage of the package.

stage_str
string
optional
stage_updated_at
date-time
optional

The datetime the package stage was updated at.

status
integer
optional
Allowed values: 1, 2, 3, 4, 5, 6, 7

The synchronisation status of the package.

status_reason
string | null
optional

A textual description for the synchronous status reason (if any

status_str
string
optional
status_updated_at
date-time
optional

The datetime the package status was updated at.

status_url
uri
optional
subtype
string
optional
summary
string | null
optional

A one-liner synopsis of this package.

sync_finished_at
date-time | null
optional

The datetime the package sync was finished at.

sync_progress
integer
optional

Synchronisation progress (from 0-100)

tags
object
optional

All tags on the package, grouped by tag type. This includes immutable tags, but doesn't distinguish them from mutable. To see which tags are immutable specifically, see the tags_immutable field.

object

tags_automatic
object
optional

All tags on the package, grouped by tag type. This includes immutable tags, but doesn't distinguish them from mutable. To see which tags are immutable specifically, see the tags_immutable field.

object

tags_immutable
object
optional

All tags on the package, grouped by tag type. This includes immutable tags, but doesn't distinguish them from mutable. To see which tags are immutable specifically, see the tags_immutable field.

object

type_display
string
optional
uploaded_at
date-time
optional

The date this package was uploaded.

uploader
string
optional
length ≥ 1
uploader_url
uri
optional
version
string | null
optional

The raw version for this package.

version_orig
string
optional
vulnerability_scan_results_url
uri
optional

The package is in the wrong state for the requested operation.

object

object

detail
string
required
length ≥ 1

An extended message for the response.

fields
object
optional

A Dictionary of related errors where key: Field and value: Array of Errors related to that field

object

Missing or invalid parameters (see detail).

object

object

detail
string
required
length ≥ 1

An extended message for the response.

fields
object
optional

A Dictionary of related errors where key: Field and value: Array of Errors related to that field

object