API information

 

cURL
The cURL examples are incomplete and won't work if you use them as shown.

Most up-to-date API Reference
If there is a discrepancy between the API Reference in the SDK download and the API Reference on this documentation website, the API Reference in the SDK download is the most up to date.

cURL
The cURL examples are incomplete and won't work if you use them as shown.

Most up-to-date API Reference
If there is a discrepancy between the API Reference in the SDK download and the API Reference on this documentation website, the API Reference in the SDK download is the most up to date.

Account

 

account_accountcreate

Creates an account

 
posthttp://zcp.zeuz.io/api/v1/account_accountcreate
curl --request POST \ --url http://zcp.zeuz.io/api/v1/account_accountcreate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
{
"Error":
"string"
"Time":
0
"Data":
"string"
}

Body Params

client_request
string
string
string
int64
object
account_create_in*
string
string
string
string
string
string
object
properties*
string

Tags

object
variant*
object
Value*

int32
array
ProvisioningAccounts*

string
string
string

Response

OK

StringError
IntegerTime
StringData

AccountID

account_accountget

Returns an account by id

 
posthttp://zcp.zeuz.io/api/v1/account_accountget
curl --request POST \ --url http://zcp.zeuz.io/api/v1/account_accountget \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
{
"Error":
"string"
"Time":
0
"Data":{
"City":
"string"
"Company":
"string"
"Country":
"string"
"Department":
"string"
"Desc":
"string"
"Devs":[
...
]
"EMail":
"string"
"ID":
"string"
"ItemCommon":{
...
}
"Managers":[
...
]
"Projects":[
...
]
"ProvisioningAccounts":[
...
]
"StreetAddr":
"string"
"Teams":[
...
]
"ZIP":
"string"
}
}

Body Params

client_request
string
string
string
int64
string

AccountID

Response

OK

StringError
IntegerTime
ObjectData
StringData.City
StringData.Company
StringData.Country
StringData.Department
StringData.Desc
[String]Data.Devs
StringData.EMail
StringData.ID

AccountID

ObjectData.ItemCommon
ObjectData.ItemCommon.ACL
IntegerData.ItemCommon.Created

Timestamp

StringData.ItemCommon.CreatedBy

DeveloperID

IntegerData.ItemCommon.Expires

Timestamp

IntegerData.ItemCommon.Modified

Timestamp

StringData.ItemCommon.ModifiedBy

DeveloperID

ObjectData.ItemCommon.Props
StringData.ItemCommon.Title
IntegerData.ItemCommon.Version
[String]Data.Managers
[String]Data.Projects
[Object]Data.ProvisioningAccounts
StringData.ProvisioningAccounts[].APIKey
StringData.ProvisioningAccounts[].ClientID
StringData.ProvisioningAccounts[].ClientSecret
StringData.ProvisioningAccounts[].GcpCredentialsFile
StringData.ProvisioningAccounts[].GcpFileName
IntegerData.ProvisioningAccounts[].GcpUploadFileDate

Timestamp

StringData.ProvisioningAccounts[].Password
StringData.ProvisioningAccounts[].ProviderID

ProviderID

StringData.ProvisioningAccounts[].SecretID
StringData.ProvisioningAccounts[].SecretKey
BooleanData.ProvisioningAccounts[].SpawnInstances
StringData.ProvisioningAccounts[].SubscriptionID
StringData.ProvisioningAccounts[].TenantID
StringData.ProvisioningAccounts[].Username
StringData.StreetAddr
[String]Data.Teams
StringData.ZIP

account_accountupdate

Updates an account

 
posthttp://zcp.zeuz.io/api/v1/account_accountupdate
curl --request POST \ --url http://zcp.zeuz.io/api/v1/account_accountupdate \ --header 'Content-Type: application/json'
Try the API to see Results

Body Params

client_request
string
string
string
int64
object
account*
string
string
string
string
string
array of strings
Devs*

string
string

AccountID

object
item_common*
object
acl*
array
List*

int64

Timestamp

string

DeveloperID

int64

Timestamp

int64

Timestamp

string

DeveloperID

object
properties*
string

Tags

object
variant*
object
Value*

int32
string
int32
array of strings
Managers*

array of strings
Projects*

array
ProvisioningAccounts*

string
array of strings
Teams*

string

Response

OK

account_developercreate

Creates a developer

 

account_developercreatepwhash

Creates a password for a developer

 

account_developerget

Returns a developer by id

 

account_developerinvite

Sends an invitation to a new developer to join

 

account_developerispasswordresethashexpired

Check the given password reset request hash if it is expired

 

account_developerpasswordreset

Updates the developer password with the provided new one

 

account_developerpasswordresetrequest

Handles the password reset request.
Sends an email to given email address with the link for resetting.

 

account_developerrevoke

Revokes a developer

 

account_developersetpwhash

Set a password for an existing developer

 

account_developersget

Returns all developers of an account id

 

account_developerupdate

Updates a developer

 

account_devquicksetup

Creates account, developer, user, env, proj and team to be used with zeuzmini

 

account_envcreate

Creates a new environment

 

account_envdelete

Deletes an environment

 

account_envget

Returns an environment by id

 

account_envservicedelete

Removes a service config from the current environment.

 

account_envserviceupdate

Saves a service config to the current environment.

 

account_envsget

Returns multiple environments by id

 

account_envupdate

Updates an environment

 

account_projectcreate

Creates a new project and a default environment for it

 

account_projectdelete

Deletes a project

 

account_projectget

Returns an project by id

 

account_projectgetenvids

Returns all env ids of project

 

account_projectsget

Returns multiple projects account by id

 

account_projectupdate

Updates a project

 

account_quotaget

Retrieves quota allowance for the specified account

 

account_teamcreate

Creates a team

 

account_teamdelete

Deletes a team

 

account_teamget

Returns an team by id

 

account_teamupdate

Updates a team

 

API Key

 

apikey_generate

Creates a new database entry with a generated API key and no secret.

 

apikey_get

Returns the API keys of a p roject.

 

apikey_revoke

Revokes the API key for the provided API key ID.

 

apikey_setpwhash

Set a secret for an API key.

 

apikey_updateacl

Updates the ACL for the provided APIKey.

 

Authentication

 

auth_check

Verifies a logged in session is still valid.

Returns the Timestamp of when the session will expire or the invalid timestamp (0) if the session is not valid.

 

auth_login

Starts a new session for:

  • Users
  • Developers
  • API Clients

Depending on the session impersonation, the range of available APIs differs.

User sessions are initiated by setting the

Login
parameter to the users' login and the
IsUser
parameter to true.

Developer sessions are initiated by setting the

Login
parameter to the developers' login.

API Client sessions are initiated by setting the

Login
parameter to the registered
APIKey
and the
IsApi
parameter to true.

The Hash value of a login request is calculated as:

Hash = base64encode( sha3_256( Nonce+TimeStamp+Secret ))

For subsequent requests, the base64 SHA3 hash of

SessionNonce
+
Secret
has to be used as the
SessionKey
in signing.
The Secret is the same secret used for generating the Hash value of the login request.

The Timestamp variable encodes microseconds since 1900-1-1 00:00 UTC and is safe for dates between 1900-1-1 00:00 UTC
and (roughly) 2185-1-1 00:00 UTC. Use the following formula to calculate the Timestamp from UNIX timestamp in milliseconds:

TimeStamp = (UNIX_TimeStamp + 2208988800000) * 1000

 

auth_logout

Terminates the current session.

 

auth_oidclogin

Service: auth | Endpoint: auth_oidclogin | APIClass: Global | AuthFlags: unauth

 

auth_oidcurl

Service: auth | Endpoint: auth_oidcurl | APIClass: Global | AuthFlags: unauth

 

auth_sessionauthorize

Service: auth | Endpoint: auth_sessionauthorize | APIClass: Global | AuthFlags: apikey

 

Echo

 

echo_1

Returns the input text slightly modified.

 

echo_2

Returns the input text slightly modified.

 

echo_3

Returns the input text slightly modified.

 

echo_4

Returns the input text modified by the rewrite rule from zeuz control panel.

 

Locality

 

locality_location_get

Returns a list of locations based on the query params provided.

 

locality_provider_get

Returns a list of providers based on the query params provided.

 

locality_region_get

Returns a list of regions based on the query params provided.

 

Machine

 

machine_countresources

Returns total number of resources assigned for an account

 

machine_gettags

Internal / Admin Only: Retrieves a list of tags from the machines owning the provided IDs.

 

machine_get

Returns general information on the machines

 

machine_getinfo

Returns general information on the machines with the provided IDs

 

Notification

 

notification_count

Returns the notifications count based on the query params provided.

 

notification_get

Returns a list of notifications based on the query params provided.

 

notification_mark

Marks the provided notifications as read or unread for the logged in developer

 

Allocation

 

allocation_create

Creates a new allocation for the current environment. To dig deeper into available parameters look here.

 

allocation_get

Retrieves one or multiple allocations, depending on the params provided.

 

allocation_request_services

Requests the temporary raise of desired unreserved payloads.
Our matchmaking service is making use of this endpoint to inform the server, how many payloads will be needed in near future.


Important note: This endpoint throttles incoming calls. After calling the endpoint once, every additional call is ignored within the next 10 seconds.

 

allocation_update

Updates the current config for an allocation.

 

Image Manager

 

imagemanager_discard

Discard the push currently in progress for the current enviroment.

 

imagemanager_getpublishstate

Returns information on the current publish state of a provided image ID

 

imagemanager_list

Lists all available images in the environment

 

imagemanager_publish

Publishes the latest pushed payload files.

The returned image ID can be used in a later operation.
e.g. Activate the pushed files in the environment.

 

imagemanager_pull

Pulls a published image to a local folder.

Returns a manifest with the local file name, the file hash, and the URL where to retrieve it.

 

imagemanager_pullV2

Pulls a published image to a local folder.

Returns a manifest with the local file name, the file hash, and the URL where to retrieve it.

 

imagemanager_pull_file_url

Requests a URL to download a file as part of a pull.

Returns a URL with a pre-configured TTL to download a file as part of a pull.

 

imagemanager_push

Pushes a local folder with a game server to a temporary location before publishing it to the enviroment.

Returns an empty manifest if all the files have been uploaded.
It will return a non-empty manifest files reported by the client
but not available on the server.

 

imagemanager_pushV2

Pushes a local folder with a game server to a temporary location before publishing it to the enviroment.

Returns an empty manifest if all the files have been uploaded.
It will return a non-empty manifest files reported by the client
but not available on the server.

 

imagemanager_push_file_url

Requests a URL to upload a file as part of a push.

Returns a URL with a pre-configured TTL to upload a file as part of a push.

 

Key-value store

 

kvstore_del

Deletes a key/value pair

 

kvstore_get

Returns a key/value pair

 

kvstore_put

Writes a key/value pair

 

Lobby

 

lobby_create

Creates a new lobby.

 

lobby_destroy

Destroys a previously started lobby.

 

lobby_join

Adds a user to a lobby.

The UserID used in the lobby API is separate from a regular User in zeuz. UserIDs do not require a valid user account and
can be assigned by the client arbitrarily.

 

lobby_kick

Forcefully removes a user from a lobby. This can only be called by the user owning the lobby.

 

lobby_leave

Removes a user from the currently joined lobby.

This can only be called by a client acting as the UserID in question and can not be used to make other users leave a lobby.

 

lobby_query

Searches for lobbies with an optional filter expression.

 

lobby_refresh

Pings a lobby to avoid expiration, and returns the state of the lobby if changed.

 

lobby_start

Starts a new lobby session.

 

lobby_update

Updates the properties of a lobby.

 

lobby_user

Updates a users' data set in a lobby.

 

logsearch_account

Returns the corresponding logs (max. 100 entries per request).

 

logsearch_checkexport

Get status for an export job

 

logsearch_downloadexport

Download a CSV file if the logs exporter is done

 

logsearch_expand

Returns the context around a log entry (50 lines before or after).

 

logsearch_startexport

Starts a logs export job

 

Matchmaking

 

matchmaking_close

Terminates a matchmaking session identified by the string parameter.

 

matchmaking_create

Initiates a new matchmaking session according to the games configuration.

The returned MatchMaking ID is used for all subsequent matchmaking requests.

 

matchmaking_createparty

Initiates a new matchmaking session according to the games configuration.

The returned MatchMaking ID is used for all subsequent matchmaking requests.

 

matchmaking_serverdestroy

Removes a registered server from the matchmaking

 

matchmaking_serverrefresh

Registers/updates a server for the matchmaker to use

 

matchmaking_stats

Queries stats of the matchmaker

 

matchmaking_update

Retrieves the current status of a matchmaking session.

 

Metrics

 

metrics_ccucount

Fetches the number of current machines within time range

 

metrics_ccucounttotal

Service: metrics | Endpoint: metrics_ccucounttotal | APIClass: Environment | AuthFlags: dev,apikey

 

metrics_machinecount

Fetches the number of current machines within time range

 

metrics_machinecounttotal

Fetches the total number of current machines at current time.

 

metrics_machinecpuusage

Fetches machine CPU usage data.

 

metrics_machinememoryusage

Fetches machine memory usage data.

 

metrics_machinenetworkreceived

Fetches machine network usage (received) data

 

metrics_machinenetworksent

Fetches machine network usage (sent) data

 

metrics_payloadcount

Fetches the number of current active payloads within time range

 

metrics_payloadcounttotal

Fetches the number of current active payloads

 

metrics_payloadcpuusage

Fetches payload CPU usage data.

 

metrics_payloadmemoryusage

Fetches payload memory usage data.

 

metrics_payloadnetworkreceived

Fetches payload network traffic received.

 

metrics_payloadnetworksent

Fetches payload network traffic sent.

 

Payload

 

payload_allocate

NOT IMPLEMENTED - Still under development.
Spawns one or multiple payload containers in a specific region, based on the allocation's payload definition.
The newly spawned payloads will be reserved from spawn on and need to be unreserved explicitly.

 

payload_create

Spawns a new container with a Payload as defined within the params provided, on the machine specified in the request.

 

payload_get

Returns a list of Payloads of the current environment, filtered by the params provided.

 

payload_getcount

Service: payload | Endpoint: payload_getcount | APIClass: Environment | AuthFlags: dev,apikey,admin

 

payload_remove

Shuts down the container running the payload with the specified ID.

If the payload is currently reserved, this call will return an error.

 

payload_reserve

Updates the state of a payload to reserved.

If the payload is currently reserved, this call will return an error.

 

payload_restart

Stops the payload and resumes it right afterwards.

This can be helpful if a gameserver is in a stale state or the payload had a timing problem on the first startup.

If the payload is not active, this call will return an error.

 

payload_resume

Activates the payload with the specified ID and spawns a container if not already running.

The reactivated payload will use the same setup as it had before it was shutdown.

If the payload is already active, this call will return an error.

 

payload_stateinfo

Returns a list of Payload states of the current environment, filtered by the params provided.

 

payload_stateupdate

Returns a list of Payload states of the current environment, filtered by the params provided.

 

payload_unreserve

Updates the state of a payload to unreserved.

If the payload is currently unreserved, this call will return an error.

 

payload_update

Updates the config for the payload with the provided ID and, if the payload is active, updates the container config the payload is running within.

If the payload is currently reserved, this call will return an error.

 

User Profile

 

profile_itemadd

Adds a single item or counts up a stackable item

 

profile_itembarter

Barters items between two users. The trade will only succees if both users
make the identical but mirrored offer. This way the clients don't need any
additional transactional state except their offer.

 

profile_itembuy

Returns the current Items and Classes configuration

 

profile_itemconfigget

Returns the current Items and Classes configuration

 

profile_itemcreate

Creates a users item

 

profile_itemget

Returns a single item by ID

 

profile_itemgetbyname

Returns a single item by ID

 

profile_itemlist

Returns a users items

 

profile_itemrem

Removes a single item or counts down a stackable item

 

profile_itemrembyname

Removes a single item or counts down a stackable item

 

profile_itemset

Updates a users item

 

profile_itemtransfer

Changes ownership of a users item.

 

profile_profiledelete

Deletes a users profile.

 

profile_profileget

Returns a users profile

 

profile_profileset

Updates a users profile.

 

profile_profilesget

Returns multiple users profiles

 

profile_usercreate

Creates a user

 

profile_userdelete

Deletes a user and its profile if it exists

 

profile_userget

Returns a user

 

profile_usergetinternal

Service: profile | Endpoint: profile_usergetinternal | APIClass: Environment | AuthFlags:

 

profile_userlookup

Finds a user by login (add displayname...)

 

profile_userset

Changes a user (does not change PWHash),
will fail if the user has been changed in between (optimistic locking)

 

profile_usersetpwhash

Changes a user's PWHash

 

profile_usersget

Returns multiple users

 

profile_userslist

Enumerates users, use pagination in. Offset as the last entry of your previous query result.

 

profile_userslookup

Finds multiple users by login (add displayname...)

 

Serverbrowser

 

serverbrowser_destroy

Terminates a serverbrowser session.

 

serverbrowser_query

Queries available servers using the session structure for filtering.

 

serverbrowser_refresh

Starts a new serverbrowser session with.

 
\n","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"docs","buttonSecondary":"reference"},"title":"zeuz Multiplayer Operations documentation","text":"Welcome to the zeuz Multiplayer Operations documentation. Here, you'll find the zuez User Manual and API reference. You can also check out the Helpdesk and Knowledge Base.","_id":"5e74dbf2ff445d002b158232"}]}">