Skip to main content

Update application

Update an existing application's metadata including name, logo, and description.

warning

Changing the application name might prevent existing apps from checking for new versions, as the application name will have changed.

Endpoint​

POST /app/update

Authentication​

HeaderValue
AuthorizationBearer <jwt_token>

Request Body​

The request uses multipart/form-data format with the following fields:

FieldTypeRequiredDescription
idstring✅The ID of the application you want to update
appstring❌New application name
filefile❌New logo for the application
descriptionstring❌New application description
tufboolean❌Enable TUF framework for application
cdnboolean❌Enable or disable API response caching on S3. Cannot be enabled for private apps
download_modestring❌Private apps only: unlisted or strict, who may download artifacts and check for updates

Example Request​

curl --location 'http://localhost:9000/app/update' \
-H "Authorization: Bearer <jwt_token>" \
--form 'data="{\"id\":\"66ae13fe5b663c058367f893\", \"app\":\"new_name\", \"tuf\": \"true\", \"cdn\": \"true\"}"'

Response​

Success Response (200 OK)​

{
"updateAppResult.Updated": true
}

Response Fields​

FieldTypeDescription
updateAppResult.UpdatedbooleanIndicates whether the application was successfully updated

Notes​

  • Only the fields you provide will be updated - omitted fields remain unchanged
  • The file field accepts common image formats (PNG, JPG, etc.)
  • Application name changes should be done carefully as they may break existing client integrations
  • Set cdn to true to cache API responses on S3, or false to disable this caching
  • cdn: true on a private app is rejected with 400
  • download_mode on a public app, or with a value other than unlisted / strict, is rejected with 400. A change takes effect on the next request: responses of private apps are never cached
  • private itself cannot be changed after creation