# Patch App
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/apps:
patch:
summary: Patch App
deprecated: false
description: >-
This endpoint is used to update an existing app with specific settings
and configurations. The settings can include:
- Deployment Management: Register, update, or deregister deployments for
the app. If an app is assigned to a deployment, it will be deployed
there when built. If a deployment is deregistered, the app will no
longer be deployed there.
- App Label: Modify the human-readable name of the app.
- Additionally, the app will always be published on a depot, regardless
of whether it is assigned to a deployment. If deployments are registered
with the app, they will receive the deployment as well.
- Note: If an app has no registered deployments, it defaults to all
available deployments.
### Required Permissions
`apps.update`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Apps
parameters:
- 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
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Unique and immutable identifier of the app.
pattern: /^[A-Za-z0-9_[\]]{2,50}$/
label:
type: string
description: Human readable string of the app.
deployments:
type: array
items:
type: string
description: Array of registered deployments.
class:
type: string
description: >-
Compute class to be used for task resources. Allowed values
are 'low', 'medium', 'high', 'critical', 'ramdisk'. If
unsure, use 'medium'.
artworks:
type: object
properties:
icon:
type: string
description: Image URL
x-apidog-orders:
- icon
description: Game artwork
x-apidog-ignore-properties: []
x-apidog-orders:
- name
- label
- deployments
- class
- artworks
required:
- name
x-apidog-ignore-properties: []
example:
name: '{{appName}}'
label: '{{appLabel}}'
class: medium
deployments:
- Deployment1
- Deployment2
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: >-
Indicates that the app update (patch) operation was
applied successfully.
message:
type: string
description: >-
A confirmation message (for example, "app modified")
confirming that the modifications to the app’s
configuration have been processed without errors.
required:
- status
- message
x-apidog-orders:
- status
- message
x-apidog-ignore-properties: []
example:
status: success
message: app modified
headers: {}
x-apidog-name: Success
'400':
description: ''
content:
application/json:
schema:
title: ''
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:
- 01JQNHN9JDAN3T9S1NNF7MVWRZ
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNHN9JDAN3T9S1NNF7MVWRZ:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: Invalid Param
'401':
description: ''
content:
application/json:
schema:
title: ''
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:
- 01JQNHMR6KTY5E596ANBHQM1DZ
required:
- status
- error
- message
x-apidog-refs:
01JQNHMR6KTY5E596ANBHQM1DZ:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: Unauthorized
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-13880924-run
components:
schemas:
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: ''
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: ''
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: []
```