# App Details
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/apps/{appName}:
get:
summary: App Details
deprecated: false
description: >-
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](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more Info.
### Required Permissions
`apps.read`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Apps
parameters:
- name: appName
in: path
description: Unique and immutable identifier of the app.
required: true
example: '{{appName}}'
schema:
type: string
- name: fields[]
in: query
description: >-
String array of fields to include in the response. Supported fields
are:
name,label,iCurBuild,maxBuilds,processing,exporting,deployed,files.
required: false
example:
- name
- label
- iCurBuild
- maxBuilds
- processing
- exporting
- sizeBytes
- created
- updated
- gog
- egs
- steam
- deployments
- dxfName
- files
- traceUpload
- training
- executables
- artworks
- exception
- error
- class
schema:
type: array
items:
type: string
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: true
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: true
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: true
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: true
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: true
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the app details were retrieved
successfully.
app:
type: object
properties:
name:
type: string
label:
type: string
dxfName:
type: string
iCurBuild:
type: integer
maxBuilds:
type: integer
processing:
type: boolean
exporting:
type: boolean
deployed:
type: array
items:
type: string
files:
type: object
properties:
dxf:
type: array
items:
type: object
properties:
name:
type: string
size:
type: integer
md5:
type: string
required:
- name
- size
- md5
x-apidog-orders:
- name
- size
- md5
x-apidog-ignore-properties: []
patches:
type: object
properties:
0001-0003:
type: array
items:
type: object
properties:
name:
type: string
size:
type: integer
md5:
type: string
required:
- name
- size
- md5
x-apidog-orders:
- name
- size
- md5
x-apidog-ignore-properties: []
0002-0003:
type: array
items:
type: object
properties:
name:
type: string
size:
type: integer
md5:
type: string
required:
- name
- size
- md5
x-apidog-orders:
- name
- size
- md5
x-apidog-ignore-properties: []
required:
- 0001-0003
- 0002-0003
x-apidog-orders:
- 0001-0003
- 0002-0003
x-apidog-ignore-properties: []
required:
- dxf
- patches
x-apidog-orders:
- dxf
- patches
x-apidog-ignore-properties: []
required:
- name
- label
- dxfName
- iCurBuild
- maxBuilds
- processing
- exporting
- deployed
- files
x-apidog-orders:
- name
- label
- dxfName
- iCurBuild
- maxBuilds
- processing
- exporting
- deployed
- files
description: >-
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).
x-apidog-ignore-properties: []
message:
type: string
description: >-
A message providing additional context regarding the
successful retrieval of the app details.
required:
- status
- app
- message
x-apidog-orders:
- status
- app
- message
x-apidog-ignore-properties: []
examples:
'1':
summary: '200: success'
value:
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
'2':
summary: '400: missing-param'
value:
status: failed
error: missing-param
message: x-rockit-beauth-token missing
detail: header parameter x-rockit-beauth-token is required
'3':
summary: '401: token-expired'
value:
status: failed
error: token-expired
message: expired token
headers: {}
x-apidog-name: '200: success'
'400':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more
invalid or missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example,
"name invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected
pattern for the organization name)
x-apidog-orders:
- 01JQNHGFPB2J04C9CV69HXG1XK
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNHGFPB2J04C9CV69HXG1XK:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: '400: missing-param'
'401':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNHGXZJ425NV1PYAHM9VGD7
required:
- status
- error
- message
x-apidog-refs:
01JQNHGXZJ425NV1PYAHM9VGD7:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: '401: token-expired'
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Apps
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-11779561-run
components:
schemas:
Invalid Param:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more invalid or
missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example, "name
invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected pattern for the
organization name)
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```