Process Traces

POST

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

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

This endpoint triggers traces processing for a given App. Traces collected from the users will be used to determine whether a new DxF image should be build by checking whether the quality or the preload has improved for your users.

Required Permissions

trigger.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)

Example:

x-rockit-orgname

string

optional

Example:

x-rockit-username

string

optional

Example:

adminPrincipal

x-rockit-api-key

string

optional

Example:

Body Params application/json

traces

object

required

Type of event, here: 'traces' for triggering trace processing

appName

string

required

Identifier of the App

reset

boolean

optional

Reset the training state of the App prior to trace processing

Example

{
    "traces": {
        "appName": "{{appName}}",
        "reset"  : false
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://Example-Server.com/be/v1/trigger' \
--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 '{
    "traces": {
        "appName": "sushi",
        "reset"  : false
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
         "statusCode" : 423,
         "error"      : "locked",
         "status"     : "failed",
         "message"    : "The app has is currently processing other tasks",
         "detail"     : "the app cannot be locked"
}

🟠400Invalid Param

🟠401Unauthorized

🟠409Item Locked

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

Delete Apps

Retry Task

Process Traces

Required Permissions#

Request

Request samples

Responses

Required Permissions