Entitlements

clients

integer

optional

created_at

date-time

optional

The datetime the token was updated at.

created_by

string

optional

length ≥ 1

created_by_url

uri

optional

default

boolean

optional

If selected this is the default token for this repository.

disable_url

uri

optional

downloads

integer

optional

enable_url

uri

optional

eula_accepted

object | null

optional

object

identifier

slug | null

optional

^[-a-zA-Z0-9_]+$
length ≤ 16

number

integer | null

optional

length ≤ 2147483647

eula_accepted_at

date-time | null

optional

The datetime the EULA was accepted at.

eula_accepted_from

string | null

optional

length ≥ 1

eula_required

boolean

optional

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

has_limits

boolean

optional

identifier

integer | null

optional

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

is_active

boolean

optional

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

is_limited

boolean

optional

limit_bandwidth

integer | null

optional

length between -9223372036854776000 and 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

optional

Allowed values: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, Exabyte, Zettabyte, Yottabyte
Defaults to Byte

limit_date_range_from

date-time | null

optional

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

limit_date_range_to

date-time | null

optional

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

limit_num_clients

integer | null

optional

length between -9223372036854776000 and 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

optional

length between -9223372036854776000 and 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

optional

length ≤ 1024

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

optional

length ≤ 1024

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

optional

object

name

string

required

length ≥ 1

refresh_url

uri

optional

reset_url

uri

optional

scheduled_reset_at

date-time | null

optional

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

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

The datetime the token was updated at.

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

Entitlements Read

Request

Response