Refresh an entitlement token in a repository.

post

https://api.cloudsmith.io/entitlements/{owner}/{repo}/{identifier}/refresh/

Path Params

owner

string

required

repo

string

required

identifier

string

required

Query Params

show_tokens

boolean

Defaults to false

Show entitlement token strings in results

Body Params

eula_required

boolean

If checked, a EULA acceptance is required for this token.

is_active

boolean

If enabled, the token will allow downloads based on configured restrictions (if any).

limit_bandwidth

integer | null

-9223372036854776000 to 9223372036854776000

The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.

limit_bandwidth_unit

string | null

enum

Defaults to Byte

limit_date_range_from

date-time | null

The starting date/time the token is allowed to be used from.

limit_date_range_to

date-time | null

The ending date/time the token is allowed to be used until.

limit_num_clients

integer | null

-9223372036854776000 to 9223372036854776000

The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.

limit_num_downloads

integer | null

-9223372036854776000 to 9223372036854776000

The maximum number of downloads allowed for the token. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.

limit_package_query

string | null

The package-based search query to apply to restrict downloads to. This uses the same syntax as the standard search used for repositories, and also supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. This will still allow access to non-package files, such as metadata.

limit_path_query

string | null

THIS WILL SOON BE DEPRECATED, please use limit_package_query instead. The path-based search query to apply to restrict downloads to. This supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. The path evaluated does not include the domain name, the namespace, the entitlement code used, the package format, etc. and it always starts with a forward slash.

metadata

object | null

scheduled_reset_at

date-time | null

The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero.

scheduled_reset_period

string | null

enum

Defaults to Never Reset

token

string

length ≥ 1

Responses

200The entitlement token has been refreshed.

400Request could not be processed (see detail).

422Missing or invalid parameters (see detail).

Cloudsmith is the new standard in Package / Artifact Management and Software Distribution