ROCKITPLAY API
  1. Apps
ROCKITPLAY API
  • ROCKIT Edge - Admin API
    • Minimal Tests
      • ping
      • submit test task
    • Admin Edge Organizations
      • Create Organization
      • Delete Organization
  • ROCKIT Edge - Backend API
    • Backend Edge Organizations
      • Create Organization
      • Delete Organization
    • Authentication
      • user login
      • authentication
    • Account Management
      • get user details
      • list users
      • Modify user
      • delete users
      • Create User / Create Machine User
    • Deployments
      • Creating Deployments
      • Get Deployments
      • Get Deployment Details
      • Modify Deployment
      • Deleting Deployments
    • Apps
      • Creating Apps
        POST
      • Import native builds
        POST
      • App Details
        GET
      • List Apps
        GET
      • patch app
        PATCH
      • Delete Apps
        DELETE
    • Triggers
      • Process Traces
      • Retry Task
    • Tasks
      • Listing Tasks
      • Task Details
      • Acknowledge Warning / Expire Task
    • Subscriptions
      • Subscribe
      • List Subscriptions
      • Unsubscribe
    • Roles
      • List Roles
      • Create Role
      • Patch Role
      • Role Details
      • Delete Roles
  • Changelog
    • Changelog
  1. Apps

List Apps

GET
https://Example-Server.com/be/v1/apps
Last modified:2025-05-08 12:00:04
This endpoint allows you to list the details of all apps of your organiztion on the ROCKIT Edge.

Required Permissions#

apps.read
See Roles for more details.

Request

Query Params
offset
integer 
optional
Pagination offset.
>= 0
Example:
0
limit
integer 
optional
Pagination limit.
>= 1
Default:
10
Example:
10
fields[]
array[string]
optional
Comma-separated list of fields to include in the response. Supported fields are: name,label,iCurBuild,maxBuilds,processing,exporting,sizeBytes,created,updated,shortcut,execPath,deployments,files,appDataPath,nKeys,nTraces
Example:
["name","label","created","updated"]
name
string 
optional
Filter by app name (supports partial matches, case sensitive).
Example:
example_app
processing
boolean 
optional
Filter by processing status.
Example:
true
exporting
boolean 
optional
Filter by exporting status.
Example:
true
order[]
array[string]
optional
Sorting order. Supported fields for sorting: name,label,created,updated. +/- for Ascending/Descending (no +/- results in ascending order)
Example:
-updated
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:
{{_edge_org_admin_beauth_token}}
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:
{{EDGE_ORG_NAME}}
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:
{{_adminPrincipal_apiKey}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://Example-Server.com/be/v1/apps?offset=0&limit=10&fields[]=name&fields[]=label&fields[]=created&fields[]=updated&name=example_app&processing=true&exporting=true&order[]=-updated' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}'

Responses

🟢200200: success
application/json
Body
status
string 
required
Indicates that the retrieval of the app list was successful.
totalCount
number 
required
An integer representing the total number of apps returned by the query.
apps
array [object] 
required
An array of app summary objects where each object includes key properties (such as the app’s name, label, current build number, and other summary details) that help to identify and overview the registered apps.
Example
{
  "status": "success",
  "totalCount": 1,
  "apps": [
    {
      "name": "Sushi",
      "label": "Sushibar: All you can feed",
      "dxfName": "b1e0efe3-3415-45ea-afa5-290c76ef3c4c",
      "iCurBuild": 3,
      "maxBuilds": 3,
      "processing": false,
      "exporting": false,
      "deployed": [
        "gcore"
      ],
      "files": {
        "dxf": [
          {
            "name": "app.json",
            "size": 685,
            "md5": "7cd715cdcabf2feb58f12e08c4b5fb74"
          },
          {
            "name": "img.json",
            "size": 204,
            "md5": "8d92dcf7ced29815e07bee58e9b983bb"
          },
          {
            "name": "img.idx.7z",
            "size": 12696,
            "md5": "4a3df23e6a37b03936979d6bb144d1c1"
          },
          {
            "name": "img.dxf",
            "size": 166711296,
            "md5": "ddfddf0f2a7ba167299d96a23d34a73b"
          }
        ],
        "patches": {
          "0001-0003": [
            {
              "name": "app.json",
              "size": 476,
              "md5": "d663daa2926b3b1d2be62c42c9551e55"
            },
            {
              "name": "img.json",
              "size": 204,
              "md5": "8d92dcf7ced29815e07bee58e9b983bb"
            },
            {
              "name": "map.7z",
              "size": 12643,
              "md5": "7d1206cde916d119d7aa32daee2a667a"
            },
            {
              "name": "patch.7z",
              "size": 254,
              "md5": "99560e8d5bf1f632b3ae5f705f13b17c"
            },
            {
              "name": "patch.json",
              "size": 356,
              "md5": "a00974f7a83ebd911bebf17f9d8bd615"
            },
            {
              "name": "patch.data",
              "size": 353,
              "md5": "e94a95aa7d1aa4008f7021a503dc2011"
            }
          ],
          "0002-0003": [
            {
              "name": "app.json",
              "size": 476,
              "md5": "d663daa2926b3b1d2be62c42c9551e55"
            },
            {
              "name": "img.json",
              "size": 204,
              "md5": "8d92dcf7ced29815e07bee58e9b983bb"
            },
            {
              "name": "map.7z",
              "size": 12643,
              "md5": "75f6538edd9e5761a0c5ac684b7f60af"
            },
            {
              "name": "patch.7z",
              "size": 253,
              "md5": "15b5b0bb5ade3bd25c8e2d92eb7cd478"
            },
            {
              "name": "patch.json",
              "size": 356,
              "md5": "38e42f3b7cbd3ad030c9f16ce525b31c"
            },
            {
              "name": "patch.data",
              "size": 368,
              "md5": "4bff49016fb290453454b3e928c8f17a"
            }
          ]
        }
      }
    }
  ]
}
🟠400400: missing-param
🟠401401: token-expired
Previous
App Details
Next
patch app
Built with