Creating Apps

This endpoint allows you to register a new app to the ROCKIT Edge.

The following minimal parameter set is required:

name

label

Game Build Rotation

When registering a new app the maximum number of game builds maxBuilds to be stored can be provided. It controls how many game builds (maxBuilds) and how many patches (maxBuilds-1) are stored. The default value is 5.

When uploading the maxBuilds+1 'th game build the oldest one will be removed from the storage. A larger value may result in higher costs:

object storage for maxBuilds game builds,

object storage for maxBuilds-1 patches, and

compute costs for generating maxBuilds-1 patches.

Required Permissions

apps.create

See Roles for more details.

Request

Header Params

x-rockit-beauth-token

string

optional

ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.

Example:

x-rockit-orgname

string

optional

Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.

Example:

x-rockit-username

string

optional

Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.

Example:

adminPrincipal

x-rockit-api-key

string

optional

Unique and imuutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.

Example:

Body Params application/json

name

string

required

Unique and immutable identifier of the app.

Match pattern:

/^[A-Za-z0-9_]{2,50}$/

label

string

required

Human readable string of the app.

maxBuilds

integer

optional

Default: 5
Maximum number of game builds to be kept on storage. This value determines how many patches are computed.

>= 2<= 10

Default:

class

enum<string>

required

Compute class to be used for task resources. Allowed values are 'low', 'medium', 'high', 'critical', 'ramdisk'. If unsure, use 'medium'.

Allowed values:

lowmediumhighcriticalramdisk

deployments

array[string]

optional

Array of registered deployments.

nTracesReliable

number

optional

Number of Traces required to consider data from statistics reliable.

>= 1<= 1000

Default:

minCoverage

number

optional

Coverage required to initiate DxF creation.

>= 0.01<= 1

Default:

0.3

maxCoverage

number

optional

Coverage required to disable trace collection.

>= 0.01<= 1

Default:

minTraceTimeSec

number

optional

Minimal time covered by Traces to enable DxF creation.

>= 300

Default:

600

nProcessTracesMin

integer

optional

Number of Traces required to trigger the creation of a new dxf image.

>= 1<= 1000

Default:

Example

{
  "name": "{{appName}}",
  "label": "{{appLabel}}",
  "maxBuilds": 3,
  "class": "medium",
  "deployments": [
    "Deployment1",
    "Deployment2"
  ],
  "nTracesReliable": 30,
  "minCoverage": 0.2,
  "maxCoverage": 0.6,
  "minTraceTimeSec": 1800,
  "nProcessTracesMin": 30,
  "uploadTrace": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200: success

application/json

Body

status

string

required

Indicates that the app creation operation was successful.

message

string

required

A confirmation message (e.g., "app created") confirming that the new app has been registered.

Example

{
  "status": "success",
  "message": "app created"
}

🟠400400: missing-param

🟠401401: token-expired

🟠409409: item-exists

Game Build Rotation#

Required Permissions#

Request

Request samples

Responses

Game Build Rotation

Required Permissions