patch app

PATCH

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

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

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 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)
Mutually excluded with x-rockit-api-key.

Example:

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:

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 imutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.

Example:

Body Params application/json

name

string

required

Unique and immutable identifier of the app.

Match pattern:

/^[A-Za-z0-9_[\]]{2,50}$/

label

string

optional

Human readable string of the app.

class

string

optional

Compute class to be used for task resources. Allowed values are 'low', 'medium', 'high', 'critical', 'ramdisk'. If unsure, use 'medium'.

deployments

array[string]

optional

Array of registered deployments.

Example

{
  "name": "{{appName}}",
  "label": "{{appLabel}}",
  "class": "medium",
  "deployments": [
    "Deployment1",
    "Deployment2"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://Example-Server.com/be/v1/apps' \
--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 '{
    "name": "sushi",
    "label": "Sushibar: All you can feed",
    "class": "medium",
    "deployments": [
        "Deployment1",
        "Deployment2"
    ]
}'

Responses

🟢200Success

application/json

Body

status

string

required

Indicates that the app update (patch) operation was applied successfully.

message

string

required

A confirmation message (for example, "app modified") confirming that the modifications to the app’s configuration have been processed without errors.

Example

{
  "status": "success",
  "message": "app modified"
}

🟠400Invalid Param

🟠401Unauthorized

List Apps

Delete Apps

patch app

Required Permissions#

Request

Request samples

Responses

Required Permissions