Allowed values: None, Username and Password Defaults to None
The authentication mode to use when accessing this upstream.
auth_secret
string | null
optional
length ≤ 4096
Secret to provide with requests to upstream.
auth_username
string | null
optional
length ≤ 64
Username to provide with requests to upstream.
available
string
optional
can_reindex
string
optional
component
string
optional
length between 1 and 64
The component to fetch from the upstream
created_at
date-time
optional
The datetime the upstream source was created.
disable_reason
string
optional
Allowed values: N/A, Upstream points to its own repository, Missing upstream source, Upstream was disabled by request of user Defaults to N/A
disable_reason_text
string
optional
Human-readable explanation of why this upstream is disabled
distro_versions
array of strings
required
Items must be unique
The distribution version that packages found on this upstream could be associated with.
string
extra_header_1
string | null
optional
^[-\w]+$ length ≤ 64
The key for extra header #1 to send to upstream.
extra_header_2
string | null
optional
^[-\w]+$ length ≤ 64
The key for extra header #2 to send to upstream.
extra_value_1
string | null
optional
^[^\n\r]+$ length ≤ 128
The value for extra header #1 to send to upstream. This is stored as plaintext, and is NOT encrypted.
extra_value_2
string | null
optional
^[^\n\r]+$ length ≤ 128
The value for extra header #2 to send to upstream. This is stored as plaintext, and is NOT encrypted.
gpg_key_fingerprint_short
string
optional
gpg_key_inline
string | null
optional
A public GPG key to associate with packages found on this upstream. When using the Cloudsmith setup script, this GPG key will be automatically imported on your deployment machines to allow upstream packages to validate and install.
gpg_key_url
uri | null
optional
length ≤ 254
When provided, Cloudsmith will fetch, validate, and associate a public GPG key found at the provided URL. When using the Cloudsmith setup script, this GPG key will be automatically imported on your deployment machines to allow upstream packages to validate and install.
gpg_verification
string
optional
Allowed values: Allow All, Warn on Invalid, Reject Invalid Defaults to Allow All
The GPG signature verification mode for this upstream.
has_failed_signature_verification
string
optional
include_sources
boolean
optional
When true, source packages will be available from this upstream.
index_package_count
string
optional
The number of packages available in this upstream source
index_status
string
optional
The current indexing status of this upstream source
is_active
boolean
optional
Whether or not this upstream is active and ready for requests.
last_indexed
string
optional
The last time this upstream source was indexed
mode
string
optional
Allowed values: Proxy Only, Cache and Proxy Defaults to Proxy Only
The mode that this upstream should operate in. Upstream sources can be used to proxy resolved packages, as well as operate in a proxy/cache or cache only mode.
name
string
required
^\w[\w \-'\.\/()]+$ length between 1 and 64
A descriptive name for this upstream source. A shortened version of this name will be used for tagging cached packages retrieved from this upstream.
pending_validation
boolean
optional
When true, this upstream source is pending validation.
priority
integer
optional
length between 1 and 32767
Upstream sources are selected for resolving requests by sequential order (1..n), followed by creation date.
slug_perm
slug
optional
^[-a-zA-Z0-9_]+$ length ≥ 1
updated_at
date-time
optional
upstream_distribution
string | null
optional
length between 1 and 64
The distribution to fetch from the upstream
upstream_url
uri
required
length between 1 and 200
The URL for this upstream source. This must be a fully qualified URL including any path elements required to reach the root of the repository.
verification_status
string
optional
Allowed values: Unknown, Invalid, Valid, Invalid (No Key) Defaults to Unknown
The signature verification status for this upstream.
verify_ssl
boolean
optional
If enabled, SSL certificates are verified when requests are made to this upstream. It's recommended to leave this enabled for all public sources to help mitigate Man-In-The-Middle (MITM) attacks. Please note this only applies to HTTPS upstreams.
Request could not be processed (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
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
