Heroic Labs Console API
The Console API from Heroic Labs — 73 operation(s) for console.
Heroic Labs Console API is one of 2 APIs that Heroic Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Console. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 92 operations across 73 paths, and defines 108 schemas. It is described by OpenAPI 2.0, at version 2.0.
Requests are made against the base URL https://cloud.heroiclabs.com.
92 operations
73 paths
108 schemas
17 DELETE39 GET32 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Heroic Labs Console API declares
2 security schemes
for authenticating requests.
It defines a basic scheme (BasicAuth).
An API key is passed in the header as Authorization (BearerJwt).
By default, every request must be authenticated.
Paths & Operations 92
Across 73 paths, the API surfaces 92 operations — 17 DELETE, 39 GET, 32 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Console 92
GET
/v2/console/account
List (and optionally filter) accounts.
DELETE
/v2/console/account
Delete (non-recorded) all user accounts.
POST
/v2/console/account
Import given account export data, creating a new account that fully matches the data.
GET
/v2/console/account/{account_id}/note
POST
/v2/console/account/{account_id}/note
DELETE
/v2/console/account/{account_id}/note/{note_id}
GET
/v2/console/account/{account_id}/wallet
Get a list of the user's wallet transactions.
GET
/v2/console/account/{id}
Get detailed account information for a single user.
DELETE
/v2/console/account/{id}
Delete all information stored for a user account.
POST
/v2/console/account/{id}
Update one or more fields on a user account.
POST
/v2/console/account/{id}/ban
Ban a user.
GET
/v2/console/account/{id}/export
Export all information stored about a user account.
GET
/v2/console/account/{id}/friend
Get a user's list of friend relationships.
DELETE
/v2/console/account/{id}/friend/{friend_id}
Delete the friend relationship between two users.
GET
/v2/console/account/{id}/group
Get a list of groups the user is a member of.
DELETE
/v2/console/account/{id}/group/{group_id}
Remove a user from a group.
PUT
/v2/console/account/{id}/import
Import given account export data, overwriting the user account's current state.
POST
/v2/console/account/{id}/unban
Unban a user.
POST
/v2/console/account/{id}/unlink/apple
Unlink the Apple ID from a user account.
POST
/v2/console/account/{id}/unlink/custom
Unlink the custom ID from a user account.
POST
/v2/console/account/{id}/unlink/device
Unlink the device ID from a user account.
POST
/v2/console/account/{id}/unlink/email
Unlink the email from a user account.
POST
/v2/console/account/{id}/unlink/facebook
Unlink the Facebook ID from a user account.
POST
/v2/console/account/{id}/unlink/facebookinstantgame
Unlink the Facebook Instant Game ID from a user account.
POST
/v2/console/account/{id}/unlink/gamecenter
Unlink the Game Center ID from a user account.
POST
/v2/console/account/{id}/unlink/google
Unlink the Google ID from a user account.
POST
/v2/console/account/{id}/unlink/steam
Unlink the Steam ID from a user account.
DELETE
/v2/console/account/{id}/wallet/{wallet_id}
Delete a wallet ledger item.
GET
/v2/console/acl/template
POST
/v2/console/acl/template
DELETE
/v2/console/acl/template/{id}
PUT
/v2/console/acl/template/{id}
DELETE
/v2/console/all
Deletes all data
GET
/v2/console/api/endpoints
API Explorer - list all endpoints
POST
/v2/console/api/endpoints/rpc/{method}
API Explorer - call a custom RPC endpoint
POST
/v2/console/api/endpoints/{method}
API Explorer - call an endpoint
GET
/v2/console/audit/log
List audit log entries with the selected filter
GET
/v2/console/audit/log/users
List console usernames that can be used to filter the audit logs
POST
/v2/console/authenticate
Authenticate a console user with username and password.
POST
/v2/console/authenticate/logout
Log out a session and invalidate the session token.
POST
/v2/console/authenticate/mfa
Change an account's MFA using a code, usually delivered over email.
POST
/v2/console/authenticate/password_change
Change an account's password using a code, usually delivered over email.
GET
/v2/console/channel
List channel messages with the selected filter
GET
/v2/console/config
Get server config and configuration warnings.
GET
/v2/console/extensions
GET
/v2/console/group
List (and optionally filter) groups.
POST
/v2/console/group/{group_id}/account/{id}/demote
Demote a user from a group.
POST
/v2/console/group/{group_id}/account/{id}/promote
Promote a user from a group.
POST
/v2/console/group/{group_id}/add
Add/join members to a group.
GET
/v2/console/group/{id}
Get detailed group information.
DELETE
/v2/console/group/{id}
Remove a group.
POST
/v2/console/group/{id}
Update one or more fields on a group.
GET
/v2/console/group/{id}/export
Export all information stored about a group.
GET
/v2/console/group/{id}/member
Get a list of members of the group.
GET
/v2/console/iap/purchase/{transaction_id}
Get purchase by transactionid
GET
/v2/console/iap/subscription/{original_transaction_id}
Get subscription by originaltransactionid
GET
/v2/console/leaderboard
List leaderboards
GET
/v2/console/leaderboard/{id}
Get leaderboard.
DELETE
/v2/console/leaderboard/{id}
Delete leaderboard
DELETE
/v2/console/leaderboard/{id}/owner/{owner_id}
Delete leaderboard record
GET
/v2/console/leaderboard/{leaderboard_id}/records
List leaderboard records.
GET
/v2/console/match
List ongoing matches
GET
/v2/console/match/{id}/state
Get current state of a running match
DELETE
/v2/console/message
Delete messages.
GET
/v2/console/notification
List notifications.
POST
/v2/console/notification
Send a notification.
GET
/v2/console/notification/{id}
Get a notification by id.
DELETE
/v2/console/notification/{id}
Delete notification
GET
/v2/console/purchase
List validated purchases
GET
/v2/console/runtime
Get runtime info
POST
/v2/console/satori/direct-message
GET
/v2/console/satori/template
GET
/v2/console/setting
List settings
GET
/v2/console/setting/{name}
Get console settings.
POST
/v2/console/setting/{name}
Update an existing setting.
GET
/v2/console/status
Get current status data for all nodes.
GET
/v2/console/storage
List (and optionally filter) storage data.
DELETE
/v2/console/storage
Delete all storage data.
GET
/v2/console/storage/collections
List storage collections
GET
/v2/console/storage/{collection}/{key}/{user_id}
Get a storage object.
DELETE
/v2/console/storage/{collection}/{key}/{user_id}
Delete a storage object.
PUT
/v2/console/storage/{collection}/{key}/{user_id}
Write a new storage object or replace an existing one.
DELETE
/v2/console/storage/{collection}/{key}/{user_id}/{version}
Delete a storage object.
GET
/v2/console/subscription
List validated subscriptions
GET
/v2/console/user
List (and optionally filter) users.
DELETE
/v2/console/user
Delete console user.
POST
/v2/console/user
Add a new console user.
GET
/v2/console/user/{username}
PUT
/v2/console/user/{username}
Update a console user.
POST
/v2/console/user/{username}/mfa/require
Sets the user's MFA as required or not required.
POST
/v2/console/user/{username}/mfa/reset
Reset a user's multi-factor authentication credentials.
POST
/v2/console/user/{username}/reset/password
Reset a user's password.
Schemas 108
The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are console.Leaderboard (22 properties), api.User (18 properties), ChannelMessage (13 properties), ValidatedSubscription (13 properties). Each schema is shown below with its type and property counts.
DeleteChannelMessagesResponse
object
1 property
ApiEndpointList
object
2 properties
console.GroupList
object
A list of groups.
3 properties
LeaderboardRecord
object
Represents a complete leaderboard record with all scores and associated metadata.
12 properties
AddAccountNoteBody
object
Add a new note for the user.
2 properties
ChannelMessage
object
A message sent on a channel.
13 properties
GroupUserList
object
A list of users belonging to a group, along with their role.
2 properties
Warning
object
A warning for a configuration field.
2 properties
UpdateUserBody
object
Request to update an existing user.
1 property
Console.WriteStorageObjectBody
object
Write a new storage object or update an existing one.
4 properties
MatchState
object
3 properties
MatchList.Match
object
2 properties
Template.View
object
A template view.
10 properties
ConsoleSession
object
A console user session.
2 properties
StorageListObject
object
An object within the storage engine.
8 properties
PurchaseList
object
A list of validated purchases stored by Nakama.
3 properties
ModuleInfo
object
2 properties
SendDirectMessageRequest
object
The request to send direct messages.
6 properties
RuntimeInfo
object
6 properties
AccountDevice
object
Send a device to the server. Used with authenticate/link/unlink and user.
2 properties
Friend
object
A friend of a user.
4 properties
api.Notification
object
A notification in the server.
7 properties
PageOptions
object
2 properties
api.User
object
A user in the server.
18 properties
WalletLedgerList
object
List of wallet ledger items for a particular user.
3 properties
CallApiEndpointBody
object
3 properties
ChannelMessageList
object
A list of channel messages, usually a result of a list operation.
4 properties
StoreEnvironment
string
- UNKNOWN: Unknown environment. - SANDBOX: Sandbox/test environment. - PRODUCTION: Production environment.
Setting
object
A single setting.
3 properties
StorageCollectionsList
object
1 property
UserPresence
object
A user session associated to a stream, usually through a list operation or a join/leave event.
5 properties
MessageIntegrationType
string
Message integration's names. - FCM: The variant for Google's Firebase Cloud Messaging. - APNS: The variant for Apple's Message system. - FACEBOOKNOTIFICATION:…
AuditLog
object
9 properties
SendDirectMessageResponse
object
The response for the SendDirectMessageRequest.
1 property
StoreProvider
string
- APPLEAPPSTORE: Apple App Store - GOOGLEPLAYSTORE: Google Play Store - HUAWEIAPPGALLERY: Huawei App Gallery - FACEBOOKINSTANTSTORE: Facebook Instant Store
AuditLogAction
string
console.NotificationList
object
3 properties
CallRpcEndpointBody
object
3 properties
Group
object
A group in the server.
12 properties
api.Match
object
Represents a realtime match.
6 properties
Any
object
1 property
ListResponse
object
A list of templates.
2 properties
UpdateAccountBody
object
Update user account information.
12 properties
AclTemplateList
object
1 property
api.Account
object
A user with additional account details. Always the current user.
7 properties
MessageChannels
object
1 property
StatusHealth
string
AuthenticateMFASetupRequest
object
Request to change MFA.
2 properties
ListAccountNotesResponse
object
Response to list user notes.
2 properties
StorageObjectAck
object
A storage acknowledgement.
6 properties
Category.View
object
A summary of a Category.
3 properties
GroupUser
object
A single user-role pair.
2 properties
UserGroupList
object
A list of groups belonging to a user, along with the user's role in each group.
2 properties
AclTemplate
object
6 properties
AddUserResponse
object
Response to create/invite a new user.
2 properties
ImportAccountBody
object
Request to import user account data.
1 property
ApiEndpointDescriptor
object
2 properties
AuditLogList
object
Audit log entries.
3 properties
SettingList
object
A list of settings.
2 properties
UnlinkDeviceBody
object
Unlink a particular device ID from a user's account.
1 property
AuthenticatePasswordChangeRequest
object
Request to change a password.
2 properties
UpdateAclTemplateBody
object
3 properties
StatusList.Status
object
The status of a Nakama node.
12 properties
UpdateSettingBody
object
Request to update an existing setting.
1 property
console.Notification
object
8 properties
RequireUserMfaBody
object
Make a user's mfa required or not.
1 property
StorageList
object
List of storage objects.
3 properties
console.Account
object
Account information.
2 properties
ValidatedPurchase
object
Validated Purchase stored by Nakama.
11 properties
CallApiEndpointResponse
object
2 properties
Permissions
object
The possible actions that can done over a resource.
3 properties
FriendList
object
A collection of zero or more friends of the user.
2 properties
AccountList
object
A list of users.
3 properties
TemplateOverride
object
An template override.
5 properties
HiroSystems
object
Hiro available systems.
5 properties
GroupExport
object
An export of all information stored for a group.
2 properties
AccountExport
object
An export of all information stored for a user account.
8 properties
StorageObject
object
An object within the storage engine.
9 properties
AuthenticateRequest
object
Authenticate a console user with username and password.
3 properties
MessageChannelType
string
Message channel types. - PUSH: Push notification. - EMAIL: Email.
console.LeaderboardList
object
A list of leaderboards.
3 properties
AddGroupUsersBody
object
Add/join users to a group.
2 properties
AuditLogUsersList
object
List of users that can be filtered in the audit logs.
1 property
ResetUserResponse
object
Request to reset a user's credentials, password or MFA.
1 property
SubscriptionList
object
A list of validated subscriptions stored by Nakama.
3 properties
AddUserRequest
object
5 properties
UserGroup
object
A single group-role pair.
2 properties
UpdateGroupBody
object
Update group information.
7 properties
IntegrationResult
object
The outcome of using a specific integration.
4 properties
LeaderboardRecordList
object
A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
5 properties
ValidatedSubscription
object
13 properties
AuthenticateLogoutRequest
object
Log out a session and invalidate a session token.
1 property
StatusList
object
List of nodes and their stats.
2 properties
rpc.Status
object
3 properties
AccountImport
object
Request to import user account data.
2 properties
console.User
object
8 properties
console.MatchList
object
A list of realtime matches, with their node names.
1 property
AclResources
string
ATTENTION: Do not modify the order of this enum. New resources should always be appended.
WalletLedger
object
An individual update to a user's wallet.
6 properties
Extensions
object
Which Console extensions are registered and available.
3 properties
Config
object
The current server configuration and any associated warnings.
3 properties
DeliveryResult
object
Details of each delivery attempt.
2 properties
UserList
object
A list of console users.
1 property
SendNotificationRequest
object
Request to send a notification.
6 properties
AddAclTemplateRequest
object
Add a new ACL template.
3 properties
AccountNote
object
A user note.
9 properties
console.Leaderboard
object
A leaderboard.
22 properties
AuthenticateMFASetupResponse
object
Response to change MFA.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Heroic Labs 1
Other APIs Heroic Labs publishes across the network.
Heroic Labs Nakama API
#Console