API Reference

Broadcasts Config

Retrieve the organization's broadcast config details.

Request

gethttps://api.cloudsmith.io/v2/orgs/{org}/broadcasts/config

Response

Responses

Retrieved the organization broadcasts config.

object

object

color_accent
string
required
^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
length between 1 and 7
color_background
string
required
^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
length between 1 and 7
color_text
string
required
^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
length between 1 and 7
company_logo_url
string
optional
show_broadcast_description
boolean
optional
show_broadcast_num_downloads
boolean
optional
show_broadcast_num_packages
boolean
optional
show_checksums
boolean
optional
show_date_modified
boolean
optional
show_gpg_fingerprint
boolean
optional
show_gpg_signature
boolean
optional
show_latest_version
boolean
optional
show_license
boolean
optional
show_package_num_downloads
boolean
optional
show_readme
boolean
optional
show_size
boolean
optional
show_status
boolean
optional
show_tags
boolean
optional
show_type
boolean
optional
show_uploaded_at
boolean
optional
show_uploaded_by
boolean
optional
show_vulnerability_check
boolean
optional
show_workspace_num_downloads
boolean
optional
show_workspace_num_packages
boolean
optional
use_workspace_avatar
boolean
optional

Request could not be processed (see detail).

object

object

detail
string
required
length ≥ 1

Organization broadcasts config not found.

object

object

detail
string
required
length ≥ 1

Missing or invalid parameters (see detail).

object

object

detail
string
required
length ≥ 1