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

Body Params application/json

Example

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

Request Code 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

Example

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

🟠400Invalid Param

🟠401Unauthorized

Modified at 2025-05-08 12:00:04

List Apps

Delete Apps

patch app

Required Permissions#

Request

Request Code Samples

Responses

Required Permissions