Providers

Provider management endpoints

List all providers

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Responses
200

List of providers

application/json
get
/providers
200

List of providers

Create a new provider

post
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Body
namestring · min: 2 · max: 100Required
service_idinteger | nullableOptional
key_valid_minutesinteger · min: 5 · max: 525960Required

Required field, minimum 5 minutes

user_select_modebooleanOptionalDefault: false
user_select_requiredinteger · min: 1 · max: 50OptionalDefault: 1
user_select_allow_duplicatesbooleanOptionalDefault: false
user_time_selection_enabledbooleanOptionalDefault: false
one_time_usebooleanOptional

Cannot be combined with expiry_on_first_use

Default: false
expiry_on_first_usebooleanOptional

Cannot be combined with one_time_use

Default: false
hwid_limitinteger · min: 1 · max: 100OptionalDefault: 1
streak_enabledbooleanOptionalDefault: false
streak_bonus_minutes_per_dayinteger · min: 1 · max: 1440OptionalDefault: 5
streak_max_bonus_hoursinteger · min: 1 · max: 168OptionalDefault: 24
Responses
post
/providers

Get provider details

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
providerIdintegerRequired
Responses
200

Provider details

No content

get
/providers/{providerId}
200

Provider details

No content

Update provider

put
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
providerIdintegerRequired
Body
namestring · min: 2 · max: 100Optional
service_idinteger | nullableOptional
key_valid_minutesinteger · min: 5 · max: 525960Optional
user_select_modebooleanOptional
user_select_requiredinteger · min: 1 · max: 50Optional
user_select_allow_duplicatesbooleanOptional
user_time_selection_enabledbooleanOptional
user_time_selection_optionsobject[] | nullableOptional
one_time_usebooleanOptional
expiry_on_first_usebooleanOptional
is_activebooleanOptional
hwid_limitinteger · min: 1 · max: 100Optional
streak_enabledbooleanOptional
streak_bonus_minutes_per_dayinteger · min: 1 · max: 1440Optional
streak_max_bonus_hoursinteger · min: 1 · max: 168Optional
Responses
200

Provider updated

No content

put
/providers/{providerId}
200

Provider updated

No content

Delete provider

delete
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
providerIdintegerRequired
Responses
200

Provider deleted

No content

delete
/providers/{providerId}
200

Provider deleted

No content

Last updated