entitlements

Get a list of all entitlements in a repository.

get/entitlements/{owner}/{repo}/

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

show_tokensboolean

Show entitlement token strings in results

querystring

A search term for querying names of entitlements.

activeboolean

If true, only include active tokens

exclude_other_user_tokensboolean

If true, exclude user tokens that belong to other users

sortstring

A field for sorting objects in ascending or descending order. Use - prefix for descending order (e.g., -name). Available options: name.

Response

Retrieved the list of entitlement tokens

access_private_broadcastsboolean

If enabled, this token can be used for private broadcasts

clientsinteger

created_atstring date-time

The datetime the token was updated at.

created_bystring

created_by_urlstring uri

defaultboolean

If selected this is the default token for this repository.

disable_urlstring uri

downloadsinteger

enable_urlstring uri

eula_accepted_atstring date-time nullable

The datetime the EULA was accepted at.

eula_accepted_fromstring nullable

eula_requiredboolean

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

has_limitsboolean

identifierinteger nullable

Deprecated (23-05-15): Please use 'slug_perm' instead. Previously: A monotonically increasing number that identified an entitlement within a repository.

is_activeboolean

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

is_limitedboolean

limit_bandwidthinteger nullable

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_date_range_fromstring date-time nullable

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

limit_date_range_tostring date-time nullable

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

limit_num_clientsinteger nullable

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_downloadsinteger nullable

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_querystring nullable

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_querystring nullable

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.

metadataobject nullable

namestring required

refresh_urlstring uri

reset_urlstring uri

scheduled_reset_atstring date-time nullable

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

self_urlstring uri

slug_permstring slug

tokenstring

updated_atstring date-time nullable

The datetime the token was updated at.

updated_bystring nullable

updated_by_urlstring uri nullable

usagestring

userstring nullable

user_urlstring uri nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.