Keys

Key management endpoints

Fetch keys with filtering and pagination

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Query parameters
pageinteger · min: 1OptionalDefault: 1
limitinteger · min: 1 · max: 100OptionalDefault: 50
discord_idstringOptional

Filter by Discord user ID

keystringOptional

Search by key value (partial match)

hwidstringOptional

Filter by HWID (partial match)

service_idintegerOptional
provider_idintegerOptional
statusstring · enumOptionalPossible values:
expires_beforestring · date-timeOptional
expires_afterstring · date-timeOptional
Responses
chevron-right
200

List of keys

application/json
get
/keys
200

List of keys

Create a single key

post
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Body
provider_idinteger · min: 1Required
service_idinteger · nullableOptional
key_namestring · max: 255 · nullableOptional
validity_minutesinteger · nullableOptional

null or 0 for forever

hwidstring · max: 255 · nullableOptional

Pre-bind single HWID on creation (use hwids array for multiple)

hwidsstring[]Optional

Array of HWIDs to pre-bind on creation (replaces hwid if both provided)

discord_idstring · nullableOptional

Discord user ID to associate with this key

Pattern: ^\\d{17,19}$
is_premiumbooleanOptional
one_time_usebooleanOptional
expiry_on_first_usebooleanOptional
no_hwidbooleanOptional
hwid_limitinteger · max: 100 · nullableOptional

0 or null for unlimited

Responses
post
/keys
201

Key created

Create multiple keys at once

post
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Body
provider_idinteger · min: 1Required
service_idinteger · min: 1 · nullableOptional
amountinteger · min: 1 · max: 100Required

Number of keys to create (1-100)

key_namestring · max: 255 · nullableOptional
validity_minutesinteger · nullableOptional
hwidstring · max: 255 · nullableOptional

Bind same HWID to all keys

discord_idstring · nullableOptional

Discord user ID to associate with all created keys

Pattern: ^\\d{17,19}$
is_premiumbooleanOptional
one_time_usebooleanOptional
expiry_on_first_usebooleanOptional
no_hwidbooleanOptional
hwid_limitinteger · max: 100 · nullableOptional
Responses
post
/keys/batch
201

Keys created

Delete multiple keys by IDs or key values

post
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Body
Responses
chevron-right
200

Keys deleted

application/json
deletedintegerOptional
requestedintegerOptional
post
/keys/bulk-delete
200

Keys deleted

Get detailed key information

get
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
keyIdone ofRequired

Key ID (numeric) or key value (string)

integerOptional
or
stringOptional
Responses
chevron-right
200

Key details

application/json
get
/keys/{keyId}
200

Key details

Update key properties

put
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
keyIdone ofRequired

Key ID (numeric) or key value (string)

integerOptional
or
stringOptional
Body
key_namestring · max: 255 · nullableOptional
validity_minutesinteger · nullableOptional
expires_atstring · date-time · nullableOptional

ISO 8601 datetime string

is_premiumbooleanOptional
one_time_usebooleanOptional
expiry_on_first_usebooleanOptional
no_hwidbooleanOptional
hwid_limitinteger · max: 100 · nullableOptional
is_invalidatedbooleanOptional
hwidsstring[]Optional

Replace all existing HWIDs with this array. Empty array clears all HWIDs.

Responses
chevron-right
200

Key updated

application/json
successbooleanOptional
messagestringOptional
keys_hwidstring[]Optional

Updated array of HWIDs (only present if hwids was provided)

put
/keys/{keyId}
200

Key updated

Delete a single key

delete
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
keyIdone ofRequired

Key ID (numeric) or key value (string)

integerOptional
or
stringOptional
Responses
chevron-right
200

Key deleted

No content

delete
/keys/{keyId}
200

Key deleted

No content

Reset all HWIDs for a key

post
Authorizations
AuthorizationstringRequired

API Key with rest-api:* scope

Path parameters
keyIdone ofRequired
integerOptional
or
stringOptional
Responses
chevron-right
200

HWIDs reset

application/json
successbooleanOptional
messagestringOptional
post
/keys/{keyId}/reset-hwid
200

HWIDs reset

Last updated