API Reference
Open Cloudsmith

Entitlements

Entitlements Partial Update

Update a specific entitlement in a repository.

Request

patchhttps://api.cloudsmith.io/v1/entitlements/{owner}/{repo}/{identifier}
Query params
show_tokens
boolean
Show entitlement token strings in results
Body params optional

Response body

object

object

eula_required
boolean
optional
is_active
boolean
optional
limit_bandwidth
integer | null
optional
length between -9223372036854776000 and 9223372036854776000
limit_bandwidth_unit
string | null
optional
Allowed values: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, Exabyte, Zettabyte, Yottabyte
Defaults to Byte
limit_date_range_from
date-time | null
optional
limit_date_range_to
date-time | null
optional
limit_num_clients
integer | null
optional
length between -9223372036854776000 and 9223372036854776000
limit_num_downloads
integer | null
optional
length between -9223372036854776000 and 9223372036854776000
limit_package_query
string | null
optional
length ≤ 1024
limit_path_query
string | null
optional
length ≤ 1024
metadata
object | null
optional
name
string
optional
length ≥ 1
scheduled_reset_at
date-time | null
optional
scheduled_reset_period
string | null
optional
Allowed values: Never Reset, Daily, Weekly, Fortnightly, Monthly, Bi-Monthly, Quarterly, Every 6 months, Annual
Defaults to Never Reset
token
string
optional
length ≥ 1

Response

Responses

Updated the specified entitlement

object

object

clients
integer
optional
created_at
date-time
optional
created_by
string
optional
length ≥ 1
created_by_url
uri
optional
default
boolean
optional
disable_url
uri
optional
downloads
integer
optional
enable_url
uri
optional
eula_accepted
object | null
optional
eula_accepted_at
date-time | null
optional
eula_accepted_from
string | null
optional
length ≥ 1
eula_required
boolean
optional
has_limits
boolean
optional
identifier
integer | null
optional
is_active
boolean
optional
is_limited
boolean
optional
limit_bandwidth
integer | null
optional
length between -9223372036854776000 and 9223372036854776000
limit_bandwidth_unit
string | null
optional
Allowed values: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, Exabyte, Zettabyte, Yottabyte
Defaults to Byte
limit_date_range_from
date-time | null
optional
limit_date_range_to
date-time | null
optional
limit_num_clients
integer | null
optional
length between -9223372036854776000 and 9223372036854776000
limit_num_downloads
integer | null
optional
length between -9223372036854776000 and 9223372036854776000
limit_package_query
string | null
optional
length ≤ 1024
limit_path_query
string | null
optional
length ≤ 1024
metadata
object | null
optional
name
string
required
length ≥ 1
refresh_url
uri
optional
reset_url
uri
optional
scheduled_reset_at
date-time | null
optional
scheduled_reset_period
string | null
optional
Allowed values: Never Reset, Daily, Weekly, Fortnightly, Monthly, Bi-Monthly, Quarterly, Every 6 months, Annual
Defaults to Never Reset
self_url
uri
optional
slug_perm
slug
optional
^[-a-zA-Z0-9_]+$
length ≥ 1
token
string
optional
length ≥ 1
updated_at
date-time | null
optional
updated_by
string | null
optional
length ≥ 1
updated_by_url
uri | null
optional
usage
string
optional
length ≥ 1
user
string | null
optional
length ≥ 1
user_url
uri | null
optional

The entitlement cannot be edited.

object

object

detail
string
required
length ≥ 1
fields
object
optional

Owner namespace or repository not found

object

object

detail
string
required
length ≥ 1
fields
object
optional

Missing or invalid parameters (see detail).

object

object

detail
string
required
length ≥ 1
fields
object
optional