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

App Details

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

Permissions#

GET /be/v1/apps requires Create (bitmask 2) permission on the apps resource.
See Roles for more Info.

Required Permissions#

apps.read
See Roles for more details.

Request

Path Params
appName
string 
required
Unique and immutable identifier of the app.
Example:
{{appName}}
Query Params
fields[]
array[string]
optional
String array of fields to include in the response. Supported fields are: name,label,iCurBuild,maxBuilds,processing,exporting,deployed,files.
Example:
["name","label"]
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/sushi?fields[]=name&fields[]=label' \
--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 app details were retrieved successfully.
app
object 
required
An object containing detailed information about the app, including its unique identifier (name), descriptive label, DXF identifier (dxfName), current build number (iCurBuild), maximum number of builds allowed (maxBuilds), processing and exporting flags, an array of deployments where the app is active, and file details (both for DXF and patches).
name
string 
required
label
string 
required
dxfName
string 
required
iCurBuild
integer 
required
maxBuilds
integer 
required
processing
boolean 
required
exporting
boolean 
required
deployed
array[string]
required
files
object 
required
message
string 
required
A message providing additional context regarding the successful retrieval of the app details.
Example
{
  "status": "success",
  "app": {
    "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
Import native builds
Next
List Apps
Built with