Skip to navigation

Initialize

Checks your AppKey and app version. Sign in to receive the update for your assigned release channel.

Headers

X-AuthlyX-NoncestringOptional
Random nonce for binding and verifying the signed response.

Request

This endpoint expects an object.
appKeystringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,31}_[a-f0-9]{48}$"
Application identifier copied from the dashboard. Not an Elite Key or Bot Key.
versionstringRequired
Version of the application making this request, for example 1.0.0.

Response

Successful
successboolean
codestring
messagestring
dataobject or null
requestIdstringformat: "uuid"
verificationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
415
Unsupported Media Type Error
429
Too Many Requests Error
503
Service Unavailable Error