CLcloudsmith
repos

List Composer upstream configs for this repository.

List Composer upstream configs for this repository.

get/repos/{owner}/{identifier}/upstream/composer/

Request

  • Base URL
    https://api.cloudsmith.io
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

OK

auth_mode'None' | 'Username and Password'

The authentication mode to use when accessing this upstream.

auth_secretstring nullable

Secret to provide with requests to upstream.

auth_usernamestring nullable

Username to provide with requests to upstream.

availableboolean

Whether the upstream is available for use.

can_reindexboolean

Whether the upstream can be reindexed.

created_atstring date-time

The datetime the upstream source was created.

disable_reason'N/A' | 'Upstream points to its own repository' | 'Missing upstream source' | 'RSA key did not verify the upstream's APKINDEX signature' | 'Upstream was disabled by request of user'
disable_reason_textstring

Human-readable explanation of why this upstream is disabled

extra_header_1string nullable

The key for extra header #1 to send to upstream.

extra_header_2string nullable

The key for extra header #2 to send to upstream.

extra_value_1string nullable

The value for extra header #1 to send to upstream. This is stored as plaintext, and is NOT encrypted.

extra_value_2string nullable

The value for extra header #2 to send to upstream. This is stored as plaintext, and is NOT encrypted.

has_failed_signature_verificationboolean

Whether the upstream has failed signature verification.

index_package_countinteger nullable

The number of packages available in this upstream source

index_statusstring nullable

The current indexing status of this upstream source

is_activeboolean

Whether or not this upstream is active and ready for requests.

last_indexedstring nullable

The last time this upstream source was indexed

mode'Proxy Only' | 'Cache and Proxy' | 'Cache 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.

namestring required

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_validationboolean

When true, this upstream source is pending validation.

priorityinteger

Upstream sources are selected for resolving requests by sequential order (1..n), followed by creation date.

slug_permstring slug
updated_atstring date-time
upstream_urlstring uri required

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.

verify_sslboolean

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.

Changes

No recorded changes to this operation across all 6 revisions of this API.