Creating Apps

POST

https://Example-Server.com/be/v1/apps

Last modified:2025-05-08 12:00:04

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

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://Example-Server.com/be/v1/apps' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "sushi",
    "label": "Sushibar: All you can feed",
    "maxBuilds": 3,
    "class": "medium",
    "deployments": [
        "Deployment1",
        "Deployment2"
    ],
    "nTracesReliable": 30,
    "minCoverage": 0.2,
    "maxCoverage": 0.6,
    "minTraceTimeSec": 1800,
    "nProcessTracesMin": 30,
    "uploadTrace": true
}'

Responses

🟢200200: success

application/json

Body

Example

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

🟠400400: missing-param

🟠401401: token-expired

🟠409409: item-exists

Modified at 2025-05-08 12:00:04

Apps

Import native builds